Remove extra argument in magic warning call

[fdroidserver.git] / README

diff --git a/README b/README
index 71e39860a0f9782bbfa653c87cdb50afa330641c..6efc5cd870555d3fdc820e214eedabcc48c4bd63 100644 (file)
--- a/README
+++ b/README
@@ -1,17 +1,30 @@
-Basic instructions:
+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.
 
-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.
+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