makebs: "fix" platform v24 zip for r02

[fdroidserver.git] / README.md

diff --git a/README.md b/README.md
index ba4f95e7166fe2f1b933c10731f74878b0dad272..aee5b82d0b8464c4bdf7294a3aba53a373cb22f9 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,7 +1,6 @@
-F-Droid Server
-==============
+# F-Droid Server
 
-[![build status](https://gitlab.com/ci/projects/6642/status.png?ref=master)](https://gitlab.com/ci/projects/6642?ref=master)
+[![build status](https://gitlab.com/fdroid/fdroidserver/badges/master/build.svg)](https://gitlab.com/fdroid/fdroidserver/builds)
 
 Server for [F-Droid](https://f-droid.org), the Free Software repository system
 for Android.
@@ -16,15 +15,15 @@ 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 3 is supported. We recommend version 3.4 or later.
 
 The easiest way to install the `fdroidserver` tools is on Ubuntu, Mint or other
 Ubuntu based distributions, you can install using:
@@ -56,24 +55,24 @@ or Cygwin, you can use it:
 
 Python's `pip` also works:
 
-       sudo pip install fdroidserver
+       sudo pip3 install fdroidserver
 
-The combination of `virtualenv` and `pip` is great for testing out the
+The combination of `pyvenv` and `pip` is great for testing out the
 latest versions of `fdroidserver`. Using `pip`, `fdroidserver` can
 even be installed straight from git. First, make sure you have
-installed the python header files, virtualenv and pip. They should be
+installed the python header files, venv and pip. They should be
 included in your OS's default package manager or you can install them
 via other mechanisms like Brew/dnf/pacman/emerge/Fink/MacPorts.
 
 For Debian based distributions:
 
-       apt-get install python-dev python-pip python-virtualenv
+       apt-get install python3-dev python3-pip python3-venv libjpeg-dev zlib1g-dev
 
 Then here's how to install:
 
        git clone https://gitlab.com/fdroid/fdroidserver.git
        cd fdroidserver
-       virtualenv env/
+       pyvenv env/
        source env/bin/activate
-       pip install -e .
-       python2 setup.py install
+       pip3 install -e .
+       python3 setup.py install