diff --git a/NOTICE b/NOTICE new file mode 100644 index 000000000..4f7aeb730 --- /dev/null +++ b/NOTICE @@ -0,0 +1,3 @@ +The AntennaPod source code comes with two libraries, flattr4j and Apache Commons Lang. Both are distributed under the Apache License, Version 2.0. +You can read a copy of this license here: +http://www.apache.org/licenses/LICENSE-2.0 \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 000000000..428bc8a05 --- /dev/null +++ b/README.md @@ -0,0 +1,31 @@ +AntennaPod +========= +This is the official repository of AntennaPod, a podcast manager for Android. + + + + + +License +---------- +AntennaPod is licensed under the MIT License. You can read the license text in the LICENSE file. + +Dependencies +------------------ +The AntennaPod app has the following dependencies: + +- 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 + +- [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. + +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. \ No newline at end of file