hans/Nominatim
1
0
Fork 1
mirror of https://github.com/osm-search/Nominatim.git synced 2026-02-14 01:47:57 +00:00
Code Issues Packages Projects Releases Wiki Activity

Improve README formatting and add install steps, adding a general cloning step before the virtual environment. This would have been helpful for me during Nominatim setup

Browse Source
This commit is contained in:
anqixxx
2025-04-07 16:51:29 -07:00
parent 800c56642b
commit 9c2fdf5eae
1 changed files with 11 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@@ -27,18 +27,25 @@ can be found at nominatim.org as well.
A quick summary of the necessary steps: A quick summary of the necessary steps:
1. Create a Python virtualenv and install the packages:
1. Clone this git repository and download the country grid
git clone https://github.com/osm-search/Nominatim.git
wget -O Nominatim/data/country_osm_grid.sql.gz https://nominatim.org/data/country_grid.sql.gz
2. Create a Python virtualenv and install the packages:
python3 -m venv nominatim-venv python3 -m venv nominatim-venv
./nominatim-venv/bin/pip install packaging/nominatim-{api,db} ./nominatim-venv/bin/pip install packaging/nominatim-{api,db}
2. Create a project directory, get OSM data and import: 3. Create a project directory, get OSM data and import:
mkdir nominatim-project mkdir nominatim-project
cd nominatim-project cd nominatim-project
../nominatim-venv/bin/nominatim import --osm-file <your planet file> ../nominatim-venv/bin/nominatim import --osm-file <your planet file> 2>&1 | tee setup.log
3. Start the webserver:
4. Start the webserver:
./nominatim-venv/bin/pip install uvicorn falcon ./nominatim-venv/bin/pip install uvicorn falcon
../nominatim-venv/bin/nominatim serve ../nominatim-venv/bin/nominatim serve