docs: update deployment to use project directory

[nominatim.git] / docs / index.md

diff --git a/docs/index.md b/docs/index.md
index 41eadde1fbb89f1c9b28e2e4d5da5b5b583760bd..d348fcfaab3d5e48fa081600dff48bcea73b17c1 100644 (file)
--- a/docs/index.md
+++ b/docs/index.md
@@ -1 +1,8 @@
 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).
+
+This guide comes in three parts:
+
+ * __[API reference](api/Overview.md)__ for users of Nominatim
+ * __[Administration Guide](admin/Installation.md)__ for those who want
+   to install their own Nominatim server
+ * __[Developer's Guide](develop/overview.md)__ for developers of the software