X-Git-Url: https://git.openstreetmap.org./nominatim.git/blobdiff_plain/6a7e0d652b1d40a397e1c1386d500101796676c4..84bac1bb4df234d0c25d94fb1abbf9289d2d55c1:/README.md diff --git a/README.md b/README.md index 6fd0cd45..3b0f328a 100644 --- a/README.md +++ b/README.md @@ -19,14 +19,6 @@ 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. Use the discussions forum -or ask for help on [help.openstreetmap.org](https://help.openstreetmap.org/).** - The latest stable release can be downloaded from https://nominatim.org. There you can also find [installation instructions for the release](https://nominatim.org/release-docs/latest/admin/Installation), as well as an extensive [Troubleshooting/FAQ section](https://nominatim.org/release-docs/latest/admin/Faq/). @@ -35,40 +27,51 @@ can be found at nominatim.org as well. A quick summary of the necessary steps: -1. Compile Nominatim: +1. Create a Python virtualenv and install the packages: - mkdir build - cd build - cmake .. - make - sudo make install + python3 -m venv nominatim-venv + ./nominatim-venv/bin/pip install packaging/nominatim-{api,db} 2. Create a project directory, get OSM data and import: mkdir nominatim-project cd nominatim-project - nominatim import --osm-file + ../nominatim-venv/bin/nominatim import --osm-file + +3. Start the webserver: -3. Point your webserver to the nominatim-project/website directory. + ./nominatim-venv/bin/pip install uvicorn falcon + ../nominatim-venv/bin/nominatim serve License ======= -The source code is available under a GPLv2 license. +The Python source code is available under a GPL license version 3 or later. +The Lua configuration files for osm2pgsql are released under the +Apache License, Version 2.0. All other files are under a GPLv2 license. Contributing ============ -Contributions, bugreport and pull requests are welcome. -For details see [contribution guide](CONTRIBUTING.md). +Contributions, bug reports and pull requests are welcome. When reporting a +bug, please use one of the +[issue templates](https://github.com/osm-search/Nominatim/issues/new/choose) +and make sure to provide all the information requested. If you are not +sure if you have really found a bug, please ask for help in the forums +first (see 'Questions' below). + +For details on contributing, have a look at the +[contribution guide](CONTRIBUTING.md). Questions and help ================== -For questions, community help and discussions you can use the -[Github discussions forum](https://github.com/osm-search/Nominatim/discussions) -or join the -[geocoding mailing list](https://lists.openstreetmap.org/listinfo/geocoding). +If you have questions about search results and the OpenStreetMap data +used in the search, use the [OSM Forum](https://community.openstreetmap.org/). + +For questions, community help and discussions around the software and +your own installation of Nominatim, use the +[Github discussions forum](https://github.com/osm-search/Nominatim/discussions).