From 4c89eb8302af486d3fa20acc894afc14f903afc1 Mon Sep 17 00:00:00 2001 From: Thor77 Date: Sun, 30 Oct 2016 19:49:19 +0100 Subject: [PATCH] Create Contributing-section (superseding "Tests") and add a short sentence about flake8 --- README.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index cd66260..08ce744 100644 --- a/README.md +++ b/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