almet/umap
1
0
Fork 0
mirror of https://github.com/umap-project/umap.git synced 2025-05-04 21:51:50 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Code review from Yohan

Browse source
This commit is contained in:
Binnette 2020-02-26 21:26:32 +01:00
parent 05b22e6427
commit 15571afadc
2 changed files with 29 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

28
docs/administration.md
View file

@ -1,28 +1,32 @@
# Administration
You can acces uMap administration page by navigating to `https://your.server.org/admin`
You can access uMap administration page by navigating to `https://your.server.org/admin`
You will have to connect with the admin account create during installation. Default admin username is umap.
You will have to connect with the admin account created during installation. Default admin username is "umap".
## Pictograms
## Icons
Pictograms are icon that can be used in your map markers.
Icons (aka pictograms in uMap sources) can be used in your map markers.
Pictograms are not embedded in uMap sources, you will have to add them manually. So you can choose which pictograms you want to use.
Icons are not embedded in uMap sources, you will have to add them manually. So you can choose which icons you want to use.
Example of pictograms libraries you may want to use:
Example of icons libraries you may want to use:
- [Maki Icons](https://labs.mapbox.com/maki-icons/) (icon set made for map designers)
- [Osmic Icons](https://gitlab.com/gmgeo/osmic)
- [SJJB Icons](http://www.sjjb.co.uk/mapicons/contactsheet)
### Import pictograms
### Import icons manually
To import pictograms on your uMap server, you will need to use command `umap import_pictograms`
You can import icons manually by going to your uMap admin page: `https://your.server.org/admin`
### Import icons automatically
To import icons on your uMap server, you will need to use command `umap import_pictograms`
Note, you can get help with `umap import_pictograms -h`
In this example, we are gonna import Maki Icons.
In this example, we will import Maki icons.
First, we download icons from main site. Inside the downloaded archive, we keep only the icons folder that contains svg files. Place this folder on your server.
@ -40,10 +44,10 @@ Notes:
- you may also want to resize image with option `-resize 24x`
- this solution is not optimal, generated png are blurry.
This will convert the svg to png and rename them from *-15.svg to *-24.png
This will convert the svg to png and rename them from `*-15.svg` to `*-24.png`
Now we will import pictograms. Note pictograms names must ends with -24.png
Now we will import icons. Note: icons names must end with `-24.png`
`umap import_pictograms --attribution "Maki Icons by Mapbox" icons`
Done. Icons are imported.
Done. Icons are imported.

14
docs/contributing.md
View file

@ -16,6 +16,10 @@ You are very welcome to help us triaging [uMap issues](https://github.com/umap-p
### Environnement setup
Choose one of the following two config:
#### Config global to your desktop
Follow the procedure [Ubuntu from scratch](ubuntu.md)
But instead using folders /etc/umap, you can create a ~/.umap folder.
@ -40,6 +44,14 @@ Then refresh your terminal
Run your local uMap and check that it is working properly.
#### Config inside your local git repo
Follow the procedure [Ubuntu from scratch](ubuntu.md)
You can use the local.py.sample in the git repo and copy it to your local git repo to umap/settings/local.py
See [Installation](install.md)
### Hacking on the code
Create a workspace folder ~/wk and go into it.
@ -49,7 +61,7 @@ Create a workspace folder ~/wk and go into it.
Several commands, needs you to be in a virtualenv:
virtualenv ~/wk/umap/venv --python=/usr/bin/python3.6
source /srv/umap/venv/bin/activate
source ~/wk/umap/venv/bin/activate
Now, command "umap" will be available