Merge branch 'update-install' into 'master'

[fdroidserver.git] / README

diff --git a/README b/README
index ee354e8d9c0f2b2989ec20d41fbb03a643a86121..c22523c5138bea436087cca2a63bb32a4f4605c9 100644 (file)
--- a/README
+++ b/README
@@ -9,4 +9,55 @@ assist in creating, testing and submitting metadata to the main repository.
 
 For documentation, please see the docs directory.
 
-Alternatively, visit http://f-droid.org/manual/
+Alternatively, visit [https://f-droid.org/manual/](https://f-droid.org/manual/)
+
+
+Installing
+----------
+
+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
+
+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
+
+On OSX, `fdroidserver` is available from third party package managers,
+like Homebrew, MacPorts, and Fink:
+
+    sudo brew install 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
+
+Python's `pip` also works:
+
+    sudo pip 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
+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
+
+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