diff --git a/README.md b/README.md index 25ce6b8..5196150 100644 --- a/README.md +++ b/README.md @@ -3,14 +3,22 @@ **Note**: User scripts are not part of the easy-osm2city concept... use only if your know what you are doing. ## General -* `analyse-run-time.py` Shows a breakdown of the runtime. Depends on `tabulate` +* `analyse-run-time.py`: Shows a breakdown of the runtime. Depends on `tabulate`. +* `common.py`: Helper functions for other scripts. ## OSM Source -* `split-world.py`: Splits the world into 10 by 10 degrees areas covering everything from 80 north to 80 south and the poles. +* `split-world.py`: Splits the world into 10 by 10 degrees areas covering everything from 80 north to 80 south and the poles. + Designed to work with 16GB of RAM. * `osmium-config`: Config files for osmium, used by the split-world script. * `chunk-import.sh`: Imports each 10 by 10 degree area in own database. ## Worldbuild * `worldbuild.py`: Old worldbuild script. +* `import-progress.py`: Import the old .json progress files into the database. +* `get-progress.py`: Export progress to .json for things like status website. +* `init-db.py`: Initializes the database with all tiles. +* `set-status.py`: Manually change the status of a tile. * `worldbuild-manager.py`: Handles job asignments and keeps track of the status. * `worldbuild-worker.py`: Starts jobs that it got asigned by the manager. +* `worldbuild-runner.py`: Handles starting and stopping of workers. +* `worldbuild-packager.py`: Packages the completed scenery, ready for distribution.