adapt quick start instructions in README to project dir

This commit is contained in:
Sarah Hoffmann 2021-02-03 10:17:22 +01:00
parent cb06d1f4ca
commit 9bca670b4e

View File

@ -24,15 +24,14 @@ Installing and running Nominatim is something for experienced system
administrators only who can do some trouble-shooting themselves. We are sorry, administrators only who can do some trouble-shooting themselves. We are sorry,
but we can not provide installation support. We are all doing this in our free but we can not provide installation support. We are all doing this in our free
time and there is just so much of that time to go around. Do not open issues in time and there is just so much of that time to go around. Do not open issues in
our bug tracker if you need help. You can ask questions on the mailing list our bug tracker if you need help. Use the discussions forum
(see below) or on [help.openstreetmap.org](https://help.openstreetmap.org/).** or ask for help on [help.openstreetmap.org](https://help.openstreetmap.org/).**
The latest stable release can be downloaded from https://nominatim.org. The latest stable release can be downloaded from https://nominatim.org.
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/). 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/).
Detailed installation instructions for the development version can be [Detailed installation instructions for current master](https://nominatim.org/release-docs/develop/admin/Installation)
found at [nominatim.org](https://nominatim.org/release-docs/develop/admin/Installation) can be found at nominatim.org as well.
as well.
A quick summary of the necessary steps: A quick summary of the necessary steps:
@ -43,11 +42,13 @@ A quick summary of the necessary steps:
cmake .. cmake ..
make make
2. Get OSM data and import: 2. Create a project directory, get OSM data and import:
./build/utils/setup.php --osm-file <your planet file> --all mkdir nominatim-project
cd nominatim-project
~/build/nominatim import --osm-file <your planet file>
3. Point your webserver to the ./build/website directory. 3. Point your webserver to the nominatim-project/website directory.
License License
@ -59,13 +60,14 @@ The source code is available under a GPLv2 license.
Contributing Contributing
============ ============
Contributions are welcome. For details see [contribution guide](CONTRIBUTING.md). Contributions, bugreport and pull requests are welcome.
For details see [contribution guide](CONTRIBUTING.md).
Both bug reports and pull requests are welcome.
Mailing list Questions and help
============ ==================
For questions you can join the geocoding mailing list, see For questions, community help and discussions you can use the
https://lists.openstreetmap.org/listinfo/geocoding [Github discussions forum](https://github.com/osm-search/Nominatim/discussions)
or join the
[geocoding mailing list](https://lists.openstreetmap.org/listinfo/geocoding).