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

Updated README (added link to wiki)

Browse Source
This commit is contained in:
daniel oeh 2013-01-12 22:31:34 +01:00
parent 49f3511cd6
commit 60f8e9b612
1 changed files with 3 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
README.md
View File

@ -16,39 +16,12 @@ AntennaPod is licensed under the MIT License. You can find the license text in t
If you want to translate AntennaPod into another language, you can visit the [Transifex project page](https://www.transifex.com/projects/p/antennapod/).
## Dependencies
## Building AntennaPod
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)
- [Apache Commons IO](http://commons.apache.org/io/download_io.cgi)
## Building
Before building, make sure you have added FlattrConfig.java as described in the 'Flattr API' - section!
### Building with ant
ActionBarSherlock and ViewPagerIndicator have to be added as library projects. Flattr4j, Apache Commons Lang and Apache Commons IO 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
- In the root directory of this project, you can then execute the following command to build it:
<pre>mvn clean package</pre>
## 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.
Information on how to build AntennaPod can be found in the [Wiki](https://github.com/danieloeh/AntennaPod/wiki/Building-AntennaPod).
## Donate
[![Flattr Button](http://api.flattr.com/button/button-static-50x60.png "Flattr This!")](https://flattr.com/thing/745609/Antennapod "AntennaPod")
Bitcoin donations can be sent to this address: <pre>1DzvtuvdW8VhDsq9GUytMyALmsHeaHEKbg</pre>