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

update docs

Browse Source 
Signed-off-by: map-per <map-per@gmx.de>
This commit is contained in:
map-per
2025-10-19 13:53:16 +02:00
committed by Bastian Greshake Tzovaras
parent b5d65a0f78
commit 448f21bb44
2 changed files with 11 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
docs/INSTALL.md
View File

@@ -27,18 +27,18 @@ Clone the repository
git clone --recurse-submodules --shallow-submodules https://codeberg.org/comaps/comaps.git git clone --recurse-submodules --shallow-submodules https://codeberg.org/comaps/comaps.git
``` ```
Go into the cloned repository:
```bash
cd comaps
./configure.sh
```
Install required packages (Ubuntu/Debian): Install required packages (Ubuntu/Debian):
```bash ```bash
sudo apt install build-essential cmake qt6-base-dev qt6-svg-dev qt6-positioning-dev libicu-dev libfreetype-dev libharfbuzz-dev libxrandr-dev libxinerama-dev libxcursor-dev libxi-dev optipng python3-pip ninja-build sudo apt install build-essential cmake qt6-base-dev qt6-svg-dev qt6-positioning-dev libicu-dev libfreetype-dev libharfbuzz-dev libxrandr-dev libxinerama-dev libxcursor-dev libxi-dev optipng python3-pip ninja-build
pip install "protobuf<3.21" --break-system-packages pip install "protobuf<3.21" --break-system-packages
``` ```
Go into the cloned repository and configure it for development:
```bash
cd comaps
./configure.sh
```
If you plan to publish the app privately in stores check [special options](#special-cases-options). If you plan to publish the app privately in stores check [special options](#special-cases-options).
### Windows ### Windows

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

@@ -63,7 +63,7 @@ cd tools/python
Build a `.mwm` map file for North Macedonia without using coastlines (it's a land-locked country anyway): Build a `.mwm` map file for North Macedonia without using coastlines (it's a land-locked country anyway):
```sh ```sh
python -m maps_generator --countries="Macedonia" --skip="Coastline" python3 -m maps_generator --countries="Macedonia" --skip="Coastline"
``` ```
It's possible to skip coastlines for countries that have a sea coast too, but the sea water will not be rendered in that case. It's possible to skip coastlines for countries that have a sea coast too, but the sea water will not be rendered in that case.
@@ -72,7 +72,7 @@ Make sure that you specify country names that are actually contained in your pbf
To see other possible command-line options: To see other possible command-line options:
```sh ```sh
python -m maps_generator -h python3 -m maps_generator -h
``` ```
## Troubleshooting ## Troubleshooting
@@ -89,7 +89,7 @@ The general log file (by default its `maps_build/generation.log`) contains outpu
4. Run 4. Run
```sh ```sh
python -m maps_generator --countries="World, WorldCoasts, Japan_*" python3 -m maps_generator --countries="World, WorldCoasts, Japan_*"
``` ```
### Rebuild stages ### Rebuild stages
@@ -98,7 +98,7 @@ For example, you changed routing code in the project and want to regenerate maps
You must have previous generation. You may regenerate starting from the routing stage and only for two mwms: You must have previous generation. You may regenerate starting from the routing stage and only for two mwms:
```sh ```sh
python -m maps_generator -c --from_stage="Routing" --countries="Japan_Kinki Region_Osaka_Osaka, Japan_Chugoku Region_Tottori" python3 -m maps_generator -c --from_stage="Routing" --countries="Japan_Kinki Region_Osaka_Osaka, Japan_Chugoku Region_Tottori"
``` ```
### Custom maps from GeoJSON ### Custom maps from GeoJSON
@@ -163,7 +163,7 @@ osmium extract -p borders.geojson germany-latest.osm.pbf -o germany_part.osm.pbf
5. Run the `maps_generator` tool: 5. Run the `maps_generator` tool:
```sh ```sh
python -m maps_generator --skip="Coastline" --without_countries="World*" python3 -m maps_generator --skip="Coastline" --without_countries="World*"
``` ```
In this example we skipped generation of the World\* files because they are ones of the most time- and resources-consuming mwms. In this example we skipped generation of the World\* files because they are ones of the most time- and resources-consuming mwms.