X-Git-Url: https://git.openstreetmap.org./nominatim.git/blobdiff_plain/eb615347d28738cdf553112afe5623c7d7ae9344..043d52821cba22ca8b430be7c178275325bb2f93:/README.md diff --git a/README.md b/README.md index dd900e3e..d130074e 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -[![Build Status](https://travis-ci.org/openstreetmap/Nominatim.svg?branch=master)](https://travis-ci.org/openstreetmap/Nominatim) +[![Build Status](https://github.com/osm-search/Nominatim/workflows/CI%20Tests/badge.svg)](https://github.com/osm-search/Nominatim/actions?query=workflow%3A%22CI+Tests%22) Nominatim ========= @@ -20,11 +20,10 @@ Installation ============ 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). +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/). -Detailed installation instructions for the development version can be -found at [nominatim.org](https://nominatim.org/release-docs/develop/admin/Installation) -as well. +[Detailed installation instructions for current master](https://nominatim.org/release-docs/develop/admin/Installation) +can be found at nominatim.org as well. A quick summary of the necessary steps: @@ -34,30 +33,45 @@ A quick summary of the necessary steps: cd build cmake .. make + sudo make install -2. Get OSM data and import: +2. Create a project directory, get OSM data and import: - ./build/utils/setup.php --osm-file --all + mkdir nominatim-project + cd nominatim-project + nominatim import --osm-file -3. Point your webserver to the ./build/website directory. +3. Point your webserver to the nominatim-project/website directory. 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 are welcome. For details see [CONTRIBUTING.md](contribution guide). +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). -Both bug reports and pull requests are welcome. +For details on contributing, have a look at the +[contribution guide](CONTRIBUTING.md). -Mailing list -============ +Questions and help +================== + +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 you can join the geocoding mailinglist, see -https://lists.openstreetmap.org/listinfo/geocoding +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).