eec57945c0
NOTE: This commit does not touch the ant build system at all, only gradle. There are currently 23 gradle projects which require configuration, let alone building, in order to build F-Droid. This takes a non-trivial amount of time/memory/cpu. Additionally, it also provides difficulties when importing the project into Android Studio - which is the IDE that many potential contributors will be using. Finally, I have over 100mb of data in the extern/ folder, and the support libraries require almost every single Android SDK to be installed, which is several GB. This is not a friendly environment to encourage people to submit merge requests. However, I'm very mindful of the need for an open source project such as F-Droid to be able to be built from source. So to make sure we have the best of both worlds, I've ensured that building all dependencies from source is still possible. The F-Droid/libs/README.md file explains in greater detail how to do this (i.e. "gradle -PsourceDeps build"). As much as possible, I've tried to make the binary dependencies fetched from jcenter. However there are still libraries which either haven't integrated required changes for F-Droid back upstream, or don't have mavenCentral/jcenter binaries available. Android preference fragment has been changed to the original upstream repository. The one we had before was because upstream hadn't merged a MR for gradfle support yet. However, that has now been merged. This version still doesn't exist in jcenter though. In order for libsuperuser to build from upstream, using `gradle -PsourceDeps`, we need to include a few gradle plugins from jcenter which are never actually used (used by upstream to release to jcenter). Even though support-v4 is included through jcenter, it is kept in the libs directory, so that ./ant-prepare.sh can use it. Update support preference fragment to newer version. There has been bugfixes commited, so lets include them in the version we are using.
F-Droid Client
Client for F-Droid, the Free Software repository system for Android.
Building from source with Gradle
Once you have checked out the version you wish to build, install gradle on your system and run:
git submodule update --init
gradle build
Android Studio
From Android Studio: File -> Import Project -> Select the cloned top folder
Building from source with Ant
The only required tools are the Android SDK and Apache Ant.
Once you have checked out the version you wish to build, run:
git submodule update --init
cd F-Droid
./ant-prepare.sh # This runs 'android update' on the libs and the main project
ant clean release
Direct download
You can download the application directly from our site or browse it in the repo.
Contributing
You are welcome to submit Merge Requests via the Gitlab web interface. You can also follow our Issue tracker and our Forums.
Translating
The res/values-* dirs are kept up to date automatically via MediaWiki's
Translate Extension. See
our translation page if you
would like to contribute.
Running the test suite
FDroid client includes a embedded Android Test Project for running tests. It
is in the test/ subfolder. To run the tests from the command line, do:
git submodule update --init
./ant-prepare.sh # This runs 'android update' on the libs and the main project
ant clean emma debug install test
You can also run the tests in Eclipse. Here's how:
- Choose File -> Import -> Android -> Existing Android Code Into Workspace for the
fdroidclient/directory. - Choose File -> Import -> Android -> Existing Android Code Into Workspace for the
fdroidclient/test/directory - If fdroid-test has errors, right-click on it, select Properties, the Java Build Path, then click on the Projects tab.
- Click on the Add... button and select
fdroidclient/ - Right-click on the fdroid-test project, then Run As... -> Android JUnit Test
Troubleshooting
When building F-Droid, the following error may occur:
Invalid file: extern/UniversalImageLoader/library/build.xml
Check the output of the ./ant-prepare.sh command. This error is often accompanied by the following message:
Error: The project either has no target set or the target is invalid. Please provide a --target to the 'android update' command.
The most likely cause of this is that your installed Android SDK is missing the target version specified by one of the dependencies. For example, at the time of writing this, UniversalImageLoader uses the "android-16" target API, however the default install of the Android SDK will usually only install the latest version ("android-20" as of writing). So you will have to install missings "android-xx" targets via the SDK manager. To get a list of already installed SDK targets, run:
$ android list targets
To get a list of targets used by fdroidclient libs, run:
$ for i in $(grep "android.library.reference" project.properties | cut -f2 -d'='); do
grep ^target $i/project.properties | cut -f2 -d'=';
done | sort | uniq | paste -s -d',' -
to install missing or all needed targets, for example "android-16" and "android-7" run:
$ android update sdk -u -t "android-16,android-7"
NOTE: While it may be tempting to add "--target=android-19" to the ant-prepare.sh script, it is not the correct solution. Although it may work, it can cause strange bugs at runtime.
License
This program is Free Software: You can use, study share and improve it at your will. Specifically you can redistribute and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.