makebs: "fix" platform v24 zip for r02

[fdroidserver.git] / README.md

diff --git a/README.md b/README.md
index 4e7933c870cbe553b212cc78f2c9cb05722d6ee0..aee5b82d0b8464c4bdf7294a3aba53a373cb22f9 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,5 +1,6 @@
-F-Droid Server
-==============
+# F-Droid Server
+
+[![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.
@@ -14,79 +15,64 @@ 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:
 
-```
-sudo apt-get install fdroidserver
-```
+       sudo apt-get install fdroidserver
 
 For older Ubuntu releases or to get the latest version, you can get
 `fdroidserver` from the Guardian Project PPA (the signing key
 fingerprint is `6B80 A842 07B3 0AC9 DEE2 35FE F50E ADDD 2234 F563`)
 
-```
-sudo add-apt-repository ppa:guardianproject/ppa
-sudo apt-get update
-sudo apt-get install fdroidserver
-```
+       sudo add-apt-repository ppa:guardianproject/ppa
+       sudo apt-get update
+       sudo apt-get install fdroidserver
 
 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:
 
-```
-yaourt -S fdroidserver
-```
+       yaourt -S fdroidserver
 
 For any platform where Python's `easy_install` is an option (e.g. OSX
 or Cygwin, you can use it:
 
-```
-sudo easy_install fdroidserver
-```
+       sudo easy_install fdroidserver
 
 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
-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
+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, 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/
-source env/bin/activate
-pip install -e .
-python2 setup.py install
-```
+       git clone https://gitlab.com/fdroid/fdroidserver.git
+       cd fdroidserver
+       pyvenv env/
+       source env/bin/activate
+       pip3 install -e .
+       python3 setup.py install