X-Git-Url: https://git.openstreetmap.org./nominatim.git/blobdiff_plain/279eae4b9263e18c1fad02a9e72972c6adcec02e..c33502516798be08f5f61fc015963168855ccfef:/README.md diff --git a/README.md b/README.md index a9a5a3e2..b643088b 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,5 @@ -[![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) +[![codecov](https://codecov.io/gh/osm-search/Nominatim/branch/master/graph/badge.svg?token=8P1LXrhCMy)](https://codecov.io/gh/osm-search/Nominatim) Nominatim ========= @@ -19,12 +20,19 @@ 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). +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,12 +42,15 @@ 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 @@ -51,13 +62,14 @@ The source code is available under a GPLv2 license. Contributing ============ -Contributions are welcome. For details see [contribution guide](CONTRIBUTING.md). - -Both bug reports and pull requests are welcome. +Contributions, bugreport and pull requests are welcome. +For details see [contribution guide](CONTRIBUTING.md). -Mailing list -============ +Questions and help +================== -For questions you can join the geocoding mailing list, see -https://lists.openstreetmap.org/listinfo/geocoding +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).