drifty/comaps
1
0
Fork 0
mirror of https://codeberg.org/comaps/comaps synced 2025-12-19 21:13:35 +00:00
Code Issues Packages Projects Releases Wiki Activity

[docs] Update docs

Browse Source 
Signed-off-by: x7z4w <x7z4w@noreply.codeberg.org>
This commit is contained in:
x7z4w
2025-07-30 08:53:19 +00:00
committed by Konstantin Pastbin
parent d7ece38279
commit f88b0afa58
8 changed files with 59 additions and 57 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
tools/python/maps_generator/README.md
View File

@@ -1,6 +1,6 @@
# maps_generator
`maps_generator` is the Python CLI for generating `.mwm` maps for the Organic Maps application. This tool functions as the driver for the `generator_tool` C++ executable.
`maps_generator` is the Python CLI for generating `.mwm` maps for the CoMaps. This tool functions as the driver for the `generator_tool` C++ executable.
**Use the `generator_tool` and application from the same release. The application does not support
maps built by a generator_tool newer than the app.**
@@ -20,7 +20,7 @@ You must have Python version >= 3.7 and complete the following steps:
git checkout 2023.06.04-13-android
```
The app version can be found in the "About" section of Organic Maps app.
The app version can be found in the "About" section of CoMaps.
2. Build the `generator_tool` binary (run from the root of the repo):
@@ -75,8 +75,6 @@ To see other possible command-line options:
python -m maps_generator -h
```
If you are not from the Organic Maps team, then you do not need the `--production` option.
## Troubleshooting
The general log file (by default its `maps_build/generation.log`) contains output of the `maps_generator` python script only. More detailed logs that include output of the `generator_tool` binary are located in the `logs/` subdir of a particular build directory, e.g. `maps_build/2023_06_04__20_05_07/logs/`.