Description
Current version of the code is quite distributed through different files, shell scripts and so on. In current state, everything is more or less impossible to run 'out of the box', and there's almost no instructions on what to use, in which order should the code run, how to setup this thing on ypur own Toolforge tool account, and so on. To improve accessibility, at least comprehensive README.md should be created.
Tasks
- Update README:
- More proper description of the project
- What each script does and how to use it (brief command line arguments description)
- How to roll out
- Setting cronjobs
- How to connect from local pc
- Creating databases (link to database_setup.md?)
- Shell scripts
- Unified shell script for setting everything up? (creating venv, installing requirements etc)
- Add code commentary on some harder to understand functions