complete-ci-tests: exit with error if setup is not correct

[fdroidserver.git] / README.md

diff --git a/README.md b/README.md
index 7357a93399607e461ca123ecc6edaf8e53c2fc29..778add95d388f224893e44cfa80e29a7363433d7 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,7 +1,6 @@
-F-Droid Server
-==============
+# F-Droid Server
 
-[![build status](https://ci.gitlab.com/projects/6642/status.png?ref=master)](https://ci.gitlab.com/projects/6642?ref=master)
+[![build status](https://gitlab.com/ci/projects/6642/status.png?ref=master)](https://gitlab.com/ci/projects/6642?ref=master)
 
 Server for [F-Droid](https://f-droid.org), the Free Software repository system
 for Android.
@@ -16,15 +15,16 @@ For documentation, please see the docs directory.
 
 Alternatively, visit [https://f-droid.org/manual/](https://f-droid.org/manual/).
 
-What is F-Droid?
-----------------
+### What is F-Droid?
 
 F-Droid is an installable catalogue of FOSS (Free and Open Source Software)
 applications for the Android platform. The client makes it easy to browse,
 install, and keep track of updates on your device.
 
-Installing
-----------
+### Installing
+
+Note that only Python 2 is supported. We recommend version 2.7.7 or
+later.
 
 The easiest way to install the `fdroidserver` tools is on Ubuntu, Mint or other
 Ubuntu based distributions, you can install using:
@@ -42,7 +42,7 @@ fingerprint is `6B80 A842 07B3 0AC9 DEE2 35FE F50E ADDD 2234 F563`)
 On OSX, `fdroidserver` is available from third party package managers,
 like Homebrew, MacPorts, and Fink:
 
-       sudo brew install fdroidserver
+       brew install fdroidserver
 
 For Arch-Linux is a package in the AUR available. If you have installed
 `yaourt` or something similiar, you can do: