docs/index.md

   1 Nominatim (from the Latin, 'by name') is a tool to search OSM data by name and address and to generate synthetic addresses of OSM points (reverse geocoding).
   2
   3 This guide comes in five parts:
   4
   5  * __[API reference](api/Overview.md)__ for users of Nominatim
   6  * __[Administration Guide](admin/Installation.md)__ for those who want
   7    to install their own Nominatim server
   8  * __[Customization Guide](customize/Overview.md)__ for those who want to
   9    adapt their own installation to their special requirements
  10  * __[Library Guide](library/Getting-Started.md)__ for Python developers who
  11    want to use Nominatim as a library in their project
  12  * __[Developer's Guide](develop/overview.md)__ for developers of the software