Create Contributing-section (superseding "Tests")
and add a short sentence about flake8
This commit is contained in:
parent
e5be93b17a
commit
4c89eb8302
11
README.md
11
README.md
|
@ -12,10 +12,6 @@ A simple Teamspeak stat-generator - based on server-logs
|
|||
- Create a config (see [Configuration](https://github.com/Thor77/TeamspeakStats#configuration))
|
||||
- Run the script `tsstats [-h]`
|
||||
|
||||
# Tests
|
||||
- Install testing-requirements `pip install -r testing_requirements.txt`
|
||||
- Run `py.test tsstats/`
|
||||
|
||||
# CMD-Arguments
|
||||
```
|
||||
usage: tsstats [-h] [-c CONFIG] [--idmap IDMAP] [-l LOG] [-o OUTPUT] [-d]
|
||||
|
@ -72,5 +68,12 @@ You can map multiple ID's to one (for example, when an user creates a new identi
|
|||
```
|
||||
The online-time of `1` and `3` will be added to the online-time of `2`
|
||||
|
||||
# Contributing
|
||||
Please make sure tests are succeeding and your code follows [flake8](https://flake8.readthedocs.io)-guidelines.
|
||||
|
||||
## Run tests
|
||||
- Install testing-requirements `pip install -r testing_requirements.txt`
|
||||
- Run `py.test tsstats/`
|
||||
|
||||
# TODO
|
||||
- Localization
|
||||
|
|
Loading…
Reference in New Issue