chiark / gitweb /
Don't crash if a magic number can't be used
[fdroidserver.git] / README
diff --git a/README b/README
index d56e5dc37c680cc07af4fe874d2e1d7afb3bb988..6efc5cd870555d3fdc820e214eedabcc48c4bd63 100644 (file)
--- a/README
+++ b/README
@@ -1,3 +1,30 @@
+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/
+
+
+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 .
+    python2 setup.py install