diff --git a/README.md b/README.md index 0021b90..17955ee 100644 --- a/README.md +++ b/README.md @@ -14,13 +14,15 @@ virtualenv -p python3 venv source venv/bin/activate ``` -- Install the dependencies : +- Install the dependencies: ``` pip install -r requirements.txt ``` -- Configure `GITHUB_USER` and `GITHUB_TOKEN` in settings.py +- (optional) Configure `GITHUB_USER` and `GITHUB_TOKEN` in `/app/settings.py`. This is currently only required to: + - override Github's unregistered user API limitation during app catalog update which prevents from updating more than about 10 entries) via `appcatalog.py` + - perform some maintenance watch tasks via `maintenancePing.py` - Init the database : @@ -34,3 +36,5 @@ pip install -r requirements.txt ``` ./manage.py update ``` + +Note: script files located at `app/scripts/` are meant to be executed via `cron`. Therefore for local development purpose they can be triggered manually.