### Prerequisites
Nominatim requires [osm2pgsql](https://osm2pgsql.org/) (>=1.8) for reading
-OSM data and [PostgreSQL](https://www.postgresql.org/) to store the data.
+OSM data and [PostgreSQL](https://www.postgresql.org/) (>=9.6) to store the data.
-On Ubuntu (>=23.04) and Debian (using backports), you can install them with:
+On Ubuntu (>=23.04) and Debian (when using backports), you can install them with:
sudo apt-get install osm2pgsql postgresql-postgis
First create a project directory for your new Nominatim database, which
is the space for additional configuration and customization:
- mkdir planet-project
+ mkdir nominatim-project
+
+Make sure you run all nominatim commands from within the project directory:
+
+ cd nominatim-project
Download an appropriate data extract, for example from
[Geofabrik](https://download.geofabrik.de/) and import the file:
nominatim import --osm-file <downlaoded-osm-data.pbf>
-You will need to install the 'nominatim-api' package to query the
-database.
+You will need to install the [`nominatim-api`](https://pypi.org/project/nominatim-api/)
+package to query the database.
## Documentation
-The documentation of the latest development version is in the
-`docs/` subdirectory. A HTML version can be found at
-https://nominatim.org/release-docs/develop/ .
+A HTML version of the documentation can be found at
+https://nominatim.org/release-docs/latest/ .
## License