README.md

   1 [![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)
   2 [![codecov](https://codecov.io/gh/osm-search/Nominatim/branch/master/graph/badge.svg?token=8P1LXrhCMy)](https://codecov.io/gh/osm-search/Nominatim)
   3
   4 Nominatim
   5 =========
   6
   7 Nominatim (from the Latin, 'by name') is a tool to search OpenStreetMap data
   8 by name and address (geocoding) and to generate synthetic addresses of
   9 OSM points (reverse geocoding). An instance with up-to-date data can be found
  10 at https://nominatim.openstreetmap.org. Nominatim is also used as one of the
  11 sources for the Search box on the OpenStreetMap home page.
  12
  13 Documentation
  14 =============
  15
  16 The documentation of the latest development version is in the
  17 `docs/` subdirectory. A HTML version can be found at
  18 https://nominatim.org/release-docs/develop/ .
  19
  20 Installation
  21 ============
  22
  23 **Nominatim is a complex piece of software and runs in a complex environment.
  24 Installing and running Nominatim is something for experienced system
  25 administrators only who can do some trouble-shooting themselves. We are sorry,
  26 but we can not provide installation support. We are all doing this in our free
  27 time and there is just so much of that time to go around. Do not open issues in
  28 our bug tracker if you need help. Use the discussions forum
  29 or ask for help on [help.openstreetmap.org](https://help.openstreetmap.org/).**
  30
  31 The latest stable release can be downloaded from https://nominatim.org.
  32 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/).
  33
  34 [Detailed installation instructions for current master](https://nominatim.org/release-docs/develop/admin/Installation)
  35 can be found at nominatim.org as well.
  36
  37 A quick summary of the necessary steps:
  38
  39 1. Compile Nominatim:
  40
  41         mkdir build
  42         cd build
  43         cmake ..
  44         make
  45         sudo make install
  46
  47 2. Create a project directory, get OSM data and import:
  48
  49         mkdir nominatim-project
  50         cd nominatim-project
  51         nominatim import --osm-file <your planet file>
  52
  53 3. Point your webserver to the nominatim-project/website directory.
  54
  55
  56 License
  57 =======
  58
  59 The source code is available under a GPLv2 license.
  60
  61
  62 Contributing
  63 ============
  64
  65 Contributions, bugreport and pull requests are welcome.
  66 For details see [contribution guide](CONTRIBUTING.md).
  67
  68
  69 Questions and help
  70 ==================
  71
  72 For questions, community help and discussions you can use the
  73 [Github discussions forum](https://github.com/osm-search/Nominatim/discussions)
  74 or join the
  75 [geocoding mailing list](https://lists.openstreetmap.org/listinfo/geocoding).