mirror of
https://github.com/YGGverse/HLState.git
synced 2026-03-31 17:15:39 +00:00
update readme
This commit is contained in:
parent
6b3fd12122
commit
690c0f6487
1 changed files with 48 additions and 0 deletions
48
README.md
48
README.md
|
|
@ -1,2 +1,50 @@
|
||||||
# HLState
|
# HLState
|
||||||
|
|
||||||
Web Stats for Half-Life Server
|
Web Stats for Half-Life Server
|
||||||
|
|
||||||
|
## Install
|
||||||
|
|
||||||
|
* `git clone https://github.com/YGGverse/HLState.git`
|
||||||
|
* `cd HLState`
|
||||||
|
* `composer install`
|
||||||
|
|
||||||
|
### Setup
|
||||||
|
|
||||||
|
* `cp .env .env.local`
|
||||||
|
* `php bin/console doctrine:database:create`
|
||||||
|
* `crontab -e`
|
||||||
|
+ `* * * * * /usr/bin/curl --silent http://address/crontab/online &> /dev/null`
|
||||||
|
|
||||||
|
## Update
|
||||||
|
|
||||||
|
* `composer update`
|
||||||
|
* `php bin/console doctrine:migrations:migrate`
|
||||||
|
* `php bin/console cache:clear`
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
* Engine sources [MIT License](https://github.com/YGGverse/HLState/blob/main/LICENSE)
|
||||||
|
|
||||||
|
## Versioning
|
||||||
|
|
||||||
|
[Semantic Versioning 2.0.0](https://semver.org/#semantic-versioning-200)
|
||||||
|
|
||||||
|
## Components
|
||||||
|
|
||||||
|
* [Symfony Framework](https://symfony.com)
|
||||||
|
* [SVG icons](https://icons.getbootstrap.com)
|
||||||
|
* [PHP Source Query](https://github.com/xPaw/PHP-Source-Query)
|
||||||
|
|
||||||
|
## Support
|
||||||
|
|
||||||
|
* [Issues](https://github.com/YGGverse/HLState/issues)
|
||||||
|
|
||||||
|
## Blog
|
||||||
|
|
||||||
|
* [Mastodon](https://mastodon.social/@YGGverse)
|
||||||
|
|
||||||
|
## See also
|
||||||
|
|
||||||
|
* [HLServers - Half-Life Servers Registry for HLState](https://github.com/YGGverse/HLServers)
|
||||||
|
* [half-life-server - Half-Life server edition by YGGverse](https://github.com/YGGverse/half-life-server)
|
||||||
|
* [pymaster - Refactored master server written in Python](https://github.com/YGGverse/pymaster)
|
||||||
Loading…
Add table
Add a link
Reference in a new issue