From 2b088032332fde21b62f69370ddf464b45f25b78 Mon Sep 17 00:00:00 2001 From: binnette Date: Fri, 24 May 2019 00:19:07 +0200 Subject: [PATCH] Add a Develop section --- README.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/README.md b/README.md index 501acde..79a3567 100644 --- a/README.md +++ b/README.md @@ -17,6 +17,34 @@ Fell free to: Translations can be done in transifex: https://www.transifex.com/openstreetmap/osm-streak/ +## Develop ## + +Prerequisites: a Linux OS or Mac OS since ruamel.yaml does not support emoji on Windows. + +Install requirements: +`pip install -r requirements.txt` + +Run the app: +`./run.py` + +### Add your account in streak.db ### + +For tests purpose only, you can manualy add your account in the streak.db database: +1. Open streak.db with sqlitebrowser or similar application +2. Add a line in the user table: + * uid: your OSM uid. You can use http://whosthat.osmz.ru to get it + * name: your OSM login + * email: your email + * lang: your language code + * set score, streak and level to 0 + +### Create a new challenge ### + +Create a new file in folder tasks. Have a look to other tasks to understand the syntax. + +Then you can test a changeset against all the tasks with following command: +`./test_chargement.py` + ## License ## OSM Streak is released under the MIT license