X-Git-Url: https://git.openstreetmap.org./nominatim.git/blobdiff_plain/a4e514033df5fbe3f494d757892589772a690cce..3e38fd806e49a2c6665dca2cb7a9e70db77feba3:/README.md diff --git a/README.md b/README.md index 1ae0dab0..3b0f328a 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 ========= @@ -19,53 +19,59 @@ 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](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/). -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: -1. Compile Nominatim: +1. Create a Python virtualenv and install the packages: + + python3 -m venv nominatim-venv + ./nominatim-venv/bin/pip install packaging/nominatim-{api,db} - mkdir build - cd build - cmake .. - make +2. Create a project directory, get OSM data and import: -2. Get OSM data and import: + mkdir nominatim-project + cd nominatim-project + ../nominatim-venv/bin/nominatim import --osm-file - ./build/utils/setup.php --osm-file --all +3. Start the webserver: -3. Point your webserver to the ./build/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 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). -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 mailing list, 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).