Merge branch 'update-install' into 'master'

[fdroidserver.git] / README

diff --git a/README b/README
index 71e39860a0f9782bbfa653c87cdb50afa330641c..c22523c5138bea436087cca2a63bb32a4f4605c9 100644 (file)
--- a/README
+++ b/README
@@ -1,17 +1,63 @@
-Basic instructions:
-
-1. Copy config.sample.py to config.py and edit the path within accordingly
-   to point to the Android tools
-2. Make a repo directory and put APK files in it
-3. Run update.py
-4. If it reports that any metadata files are missing, you can create them
-   in the metadata directory and run it again.
-5. To ease creation of metadata files, run update.py with the -c option. It
-   will create 'skeleton' metadata files that are missing, and you can then
-   just edit them and fill in the details.
-6. Then, if you've changed things, run update.py again.
-7. Running update.py adds an Icons directory into the repo directory, and
-   also creates the repository index (index.xml).
-8. Transfer the repo directory to the appropriate http server. The script
-   in upload.sh is an example of how to do this.
+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.
 
+The F-Droid server tools provide various scripts and tools that are used to
+maintain the main F-Droid application repository. You can use these same tools
+to create your own additional or alternative repository for publishing, or to
+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/](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