packaging/nominatim-core/README.md

   1 Nominatim - Core Package
   2 =========
   3
   4 Nominatim is a tool to search OpenStreetMap data
   5 by name and address (geocoding) and to generate synthetic addresses of
   6 OSM points (reverse geocoding).
   7
   8 This is the core pacakage containing resources and code shared by
   9 Nominatim's frontend `nominatim_api` and backend `nominatim_db`. You
  10 usually don't want to install this package directly.
  11
  12 Documentation
  13 =============
  14
  15 The documentation of the latest development version is in the
  16 `docs/` subdirectory. A HTML version can be found at
  17 https://nominatim.org/release-docs/develop/ .
  18
  19 License
  20 =======
  21
  22 The source code is available under a GPLv2 license.