docs/index.md

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