2b11a47a2f
Add a section on setting up the development environment which now also includes the former chapter on recreating the documentation. Move the README from test/ into the manual as the new Testing chapter. |
||
|---|---|---|
| cmake | ||
| data | ||
| docs | ||
| lib | ||
| module | ||
| munin | ||
| nominatim | ||
| osm2pgsql@b8af2b242f | ||
| settings | ||
| sql | ||
| test | ||
| utils | ||
| vagrant | ||
| website | ||
| .gitignore | ||
| .gitmodules | ||
| .travis.yml | ||
| AUTHORS | ||
| ChangeLog | ||
| CMakeLists.txt | ||
| CONTRIBUTING.md | ||
| COPYING | ||
| phpcs.xml | ||
| README.md | ||
| VAGRANT.md | ||
| Vagrantfile | ||
Nominatim
Nominatim (from the Latin, 'by name') is a tool to search OpenStreetMap data by name and address (geocoding) and to generate synthetic addresses of OSM points (reverse geocoding). An instance with up-to-date data can be found at https://nominatim.openstreetmap.org. Nominatim is also used as one of the sources for the Search box on the OpenStreetMap home page.
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/ .
Installation
Nominatim is a complex piece of software and runs in a complex environment. Installing and running Nominatim is something for experienced system administrators only who can do some trouble-shooting themselves. We are sorry, but we can not provide installation support. We are all doing this in our free time and there is just so much of that time to go around. Do not open issues in our bug tracker if you need help. You can ask questions on the mailing list (see below) or on help.openstreetmap.org.
The latest stable release can be downloaded from https://nominatim.org. There you can also find installation instructions for the release, as well as an extensive Troubleshooting/FAQ section.
Detailed installation instructions for the development version can be found at nominatim.org as well.
A quick summary of the necessary steps:
-
Compile Nominatim:
mkdir build cd build cmake .. make -
Get OSM data and import:
./build/utils/setup.php --osm-file <your planet file> --all -
Point your webserver to the ./build/website directory.
License
The source code is available under a GPLv2 license.
Contributing
Contributions are welcome. For details see contribution guide.
Both bug reports and pull requests are welcome.
Mailing list
For questions you can join the geocoding mailing list, see https://lists.openstreetmap.org/listinfo/geocoding