chiark / gitweb /
add generic installation instructions to README
authorHans-Christoph Steiner <hans@eds.org>
Fri, 18 Apr 2014 17:12:29 +0000 (13:12 -0400)
committerHans-Christoph Steiner <hans@eds.org>
Wed, 23 Apr 2014 03:13:38 +0000 (23:13 -0400)
README

diff --git a/README b/README
index 4a9ac0755259fa294a4b1f9973de713617e9c4a9..218deff818099d04e9a293fa2709ad06c282cb7d 100644 (file)
--- a/README
+++ b/README
@@ -10,3 +10,21 @@ assist in creating, testing and submitting metadata to the main repository.
 For documentation, please see the docs directory.
 
 Alternatively, visit https://f-droid.org/manual/
+
+
+Installing
+----------
+
+The easiest way to install the fdroidserver tools is to use virtualenv and pip
+(if you are Debian/Ubuntu/Mint/etc, you can first try installing using
+`apt-get install fdroidserver`).  First, make sure you have virtualenv
+installed, it should be included in your OS's Python distribution or via other
+mechanisms like dnf/yum/pacman/emerge/Fink/MacPorts/Brew.  Then here's how to
+install:
+
+    git clone https://gitlab.com/fdroid/fdroidserver.git
+    cd fdroidserver
+    virtualenv env/
+    . env/bin/activate
+    pip install -e .
+    python setup.py install