]> git.openstreetmap.org Git - nominatim.git/blobdiff - README.md
tests: always create the config file
[nominatim.git] / README.md
index 406f7c858a065a11ffa56c6d806680a94f471fce..80bbfbde3a550ac8d3ebab439604f05807e8f068 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
-[![Build Status](https://travis-ci.org/openstreetmap/Nominatim.svg?branch=master)](https://travis-ci.org/openstreetmap/Nominatim)
+[![Build Status](https://github.com/osm-search/Nominatim/workflows/CI%20Tests/badge.svg)](https://github.com/osm-search/Nominatim/actions?query=workflow%3A%22CI+Tests%22)
 
 Nominatim
 =========
 
 Nominatim
 =========
@@ -19,8 +19,16 @@ https://nominatim.org/release-docs/develop/ .
 Installation
 ============
 
 Installation
 ============
 
+**Nominatim is a complex piece of software and runs in a complex environment.
+Installing and running Nominatim is something for experienced system
+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
+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
+(see below) or 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).
+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
 found at [nominatim.org](https://nominatim.org/release-docs/develop/admin/Installation)
 
 Detailed installation instructions for the development version can be
 found at [nominatim.org](https://nominatim.org/release-docs/develop/admin/Installation)
@@ -47,11 +55,17 @@ License
 
 The source code is available under a GPLv2 license.
 
 
 The source code is available under a GPLv2 license.
 
-Contact and Bug reports
-======================
 
 
-For questions you can join the geocoding mailinglist, see
-https://lists.openstreetmap.org/listinfo/geocoding
+Contributing
+============
+
+Contributions are welcome. For details see [contribution guide](CONTRIBUTING.md).
+
+Both bug reports and pull requests are welcome.
 
 
-Bugs may be reported on the github project site:
-https://github.com/openstreetmap/Nominatim
+
+Mailing list
+============
+
+For questions you can join the geocoding mailing list, see
+https://lists.openstreetmap.org/listinfo/geocoding