README

   1 F-Droid is an installable catalogue of FOSS (Free and Open Source Software)
   2 applications for the Android platform. The client makes it easy to browse,
   3 install, and keep track of updates on your device.
   4
   5 The F-Droid server tools provide various scripts and tools that are used to
   6 maintain the main F-Droid application repository. You can use these same tools
   7 to create your own additional or alternative repository for publishing, or to
   8 assist in creating, testing and submitting metadata to the main repository.
   9
  10 For documentation, please see the docs directory.
  11
  12 Alternatively, visit [https://f-droid.org/manual/](https://f-droid.org/manual/)
  13
  14
  15 Installing
  16 ----------
  17
  18 The easiest way to install the `fdroidserver` tools is on Debian, Ubuntu, Mint
  19 or other Debian based distributions, you can install using:
  20
  21     sudo apt-get install fdroidserver
  22
  23 For older Ubuntu releases or to get the latest version, you can get
  24 `fdroidserver` from the Guardian Project PPA (the signing key
  25 fingerprint is `6B80 A842 07B3 0AC9 DEE2 35FE F50E ADDD 2234 F563`)
  26
  27     sudo add-apt-repository ppa:guardianproject/ppa
  28     sudo apt-get update
  29     sudo apt-get install fdroidserver
  30
  31 On OSX, `fdroidserver` is available from third party package managers,
  32 like Homebrew, MacPorts, and Fink:
  33
  34     sudo brew install fdroidserver
  35
  36 For any platform where Python's `easy_install` is an option (e.g. OSX
  37 or Cygwin, you can use it:
  38
  39     sudo easy_install fdroidserver
  40
  41 Python's `pip` also works:
  42
  43     sudo pip install fdroidserver
  44
  45 The combination of `virtualenv` and `pip` is great for testing out the
  46 latest versions of `fdroidserver`.  Using `pip`, `fdroidserver` can
  47 even be installed straight from git.  First, make sure you have
  48 installed the python header files, virtualenv and pip.  They should be
  49 included in your OS's default package manager or you can install them
  50 via other mechanisms like Brew/dnf/pacman/emerge/Fink/MacPorts.
  51
  52 For Debian based distributions:
  53
  54     apt-get install python-dev python-pip python-virtualenv
  55
  56 Then here's how to install:
  57
  58     git clone https://gitlab.com/fdroid/fdroidserver.git
  59     cd fdroidserver
  60     virtualenv env/
  61     source env/bin/activate
  62     pip install -e .
  63     python2 setup.py install