From 9c2fdf5eaec3a89b5089d69c984b7cb67e49b230 Mon Sep 17 00:00:00 2001 From: anqixxx Date: Mon, 7 Apr 2025 16:51:29 -0700 Subject: [PATCH] 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 --- README.md | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 3b0f328a..54bdbf8e 100644 --- a/README.md +++ b/README.md @@ -27,18 +27,25 @@ can be found at nominatim.org as well. 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 ./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 cd nominatim-project - ../nominatim-venv/bin/nominatim import --osm-file + ../nominatim-venv/bin/nominatim import --osm-file 2>&1 | tee setup.log + -3. Start the webserver: +4. Start the webserver: ./nominatim-venv/bin/pip install uvicorn falcon ../nominatim-venv/bin/nominatim serve -- 2.39.5