From e561163f93c9f7a3d2aea49543b5b9599e54ea51 Mon Sep 17 00:00:00 2001
From: emkael <emkael@tlen.pl>
Date: Thu, 6 Apr 2017 01:53:44 +0200
Subject: Documentation tips + example config for players histories

---
 docs/building.md | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)
 create mode 100644 docs/building.md

(limited to 'docs/building.md')

diff --git a/docs/building.md b/docs/building.md
new file mode 100644
index 0000000..32de2d4
--- /dev/null
+++ b/docs/building.md
@@ -0,0 +1,18 @@
+To build initial ranking:
+
+```
+python ranking.py DATE > http/FILENAME.html
+```
+
+To build subsequent rankings:
+
+```
+python ranking.py DATE PREVIOUS_DATE > http/FILENAME.html
+```
+
+To build players' pages:
+```
+python players.py http/players/ [DATES_CONFIG]
+```
+
+Name, surname and club are always used from the current `players` table. Regions, genders and age categories are read per-ranking.
-- 
cgit v1.2.3