Castopod/AntennaPod
1
0
Fork 0
mirror of https://github.com/AntennaPod/AntennaPod.git synced 2024-12-25 16:23:54 +01:00
Code Issues Packages Projects Releases Wiki Activity

Updated readme

Browse Source
This commit is contained in:
daniel oeh 2012-07-31 12:02:01 +02:00
parent 53e00b95d5
commit 0860d1c007
1 changed files with 30 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

47
README.md
View File

@ -1,31 +1,44 @@
AntennaPod
=========
# AntennaPod
This is the official repository of AntennaPod, a podcast manager for Android.
<a href="https://play.google.com/store/apps/details?id=de.danoeh.antennapod" alt="Download from Google Play">
<img src="http://www.android.com/images/brand/android_app_on_play_large.png">
</a>
License
----------
AntennaPod is licensed under the MIT License. You can read the license text in the LICENSE file.
## License
Dependencies
------------------
The AntennaPod app has the following dependencies:
AntennaPod is licensed under the MIT License. You can find the license text in the LICENSE file.
- Android support library v4, already included in the libs directory
- [flattr4j](https://github.com/shred/flattr4j), already included in the libs directory
- [Apache Commons Lang](http://commons.apache.org/lang/), already included in the libs directory
## Dependencies
AntennaPod has the following dependencies:
- [flattr4j](http://www.shredzone.org/projects/flattr4j/files)
- [Apache Commons Lang](http://commons.apache.org/lang/download_lang.cgi)
- [ActionBarSherlock](https://github.com/JakeWharton/ActionBarSherlock)
- [ViewPagerIndicator](https://github.com/JakeWharton/Android-ViewPagerIndicator)
- Gridlayout from the support v7 library
ActionBarSherlock, ViewPagerIndicator and Gridlayout are not included in the repository. In order to build the app, you have to add them as a library project.
I am currently using Ant to build the project, but I think I am going to switch to Maven soon to make the build process more convenient.
### Building with ant
ActionBarSherlock and ViewPagerIndicator have to be added as library projects. Flattr4j and ApacheCommons Lang are jar-libraries and have to be copied into the libs folder in the root directory.
### Building with maven
You can already build unsigned packages with maven, if you add annotations.jar from the Android SDK to your local maven repository. You don't have to do anything described in the 'Building with ant' section in order to build with maven.
- Make sure the ANDROID_HOME variable is set to the location of your Android SDK installation
- Navigate from your Android SDK directory into tools/support
- Execute the following command:
mvn install:install-file -Dfile=./annotations.jar -DgroupId=android.tools.support -DartifactId=annotations -Dversion=1.0 -Dpackaging=jar
- In the root directory of this project, you can then execute the following command to build it:
mvn clean package
## Flattr API
Flattr API
------------
AntennaPod accesses the flattr API for flattring podcasts. In order to gain access, a client ID and a client secret is required, which you can get by registering a new app on the flattr website. The official API credentials have been excluded from the public source code.
In order to successfully build the project, a java class called FlattrConfig with two fields containing the credentials has to be created in src/de/danoeh/antennapod/util/flattr . You can also use the file called FlattrConfig.java.example to do that. If you leave the two fields blank, everything except the authentication process will work.
In order to successfully build the project, a java class called FlattrConfig with two fields containing the credentials has to be created in src/de/danoeh/antennapod/util/flattr . You can also use the file called FlattrConfig.java.example to do that. If you leave the two fields blank, everything except the authentication process will work.