improve wording

as per review
This commit is contained in:
Sarah Hoffmann
2024-06-29 16:27:26 +02:00
parent fa1c402b47
commit ecf4693a79
8 changed files with 45 additions and 30 deletions

View File

@@ -4,8 +4,8 @@ Nominatim is a tool to search OpenStreetMap data
by name and address (geocoding) and to generate synthetic addresses of
OSM points (reverse geocoding).
This module implements the library for searching in a Nominatim database
imported with the 'nominatim-db' package.
This module implements the library for searching a Nominatim database
imported with the [`nominatim-db`](https://pypi.org/project/nominatim-db/) package.
## Installation
@@ -15,7 +15,7 @@ To install the Nominatim API from pypi, run:
## Running a Nominatim server
You need falcon or starlette to run Nominatim as a service, as well as
You need Falcon or Starlette to run Nominatim as a service, as well as
an ASGI-capable server like uvicorn. To install them from pypi run:
pip install falcon uvicorn
@@ -28,10 +28,10 @@ package. Go to the project directory, then run uvicorn as:
## Documentation
The full documentation for the Nominatim library can be found at:
https://nominatim.org/release-docs/develop/library/Getting-Started/
https://nominatim.org/release-docs/latest/library/Getting-Started/
The v1 API of the server is documented at:
https://nominatim.org/release-docs/develop/api/Overview/
https://nominatim.org/release-docs/latest/api/Overview/
## License

View File

@@ -24,7 +24,9 @@ dynamic = ["version"]
[project.urls]
Homepage = "https://nominatim.org"
Documentation = "https://nominatim.org/release-docs/latest/"
Issues = "https://github.com/osm-search/Nominatim/issues"
Repository = "https://github.com/osm-search/Nominatim"
[build-system]
requires = ["hatchling"]

View File

@@ -12,9 +12,9 @@ command-line tool for importing and maintaining the database.
### 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
@@ -30,21 +30,24 @@ To install Nominatim from pypi, run:
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

View File

@@ -26,8 +26,9 @@ dynamic = ["version"]
[project.urls]
Homepage = "https://nominatim.org"
Issues = "https://github.com/osm-search/Nominatim/issues"
Documentation = "https://nominatim.org/release-docs/latest/"
Issues = "https://github.com/osm-search/Nominatim/issues"
Repository = "https://github.com/osm-search/Nominatim"
[build-system]
requires = ["hatchling"]