Merge branch 'master' into django2
[mygpo.git] / README.md
blobd71aef831394ef442e2830b55f2ea6d0c40bd20b
1 mygpo - Source for gpodder.net
2 ==============================
4 mygpo is the website and webservice powering gpodder.net.
8 License
9 -------
10 mygpo is licensed under the GNU Affero General Public License Version 3. See file [COPYING](COPYING) for details.
13 Installation
14 ------------
15 See the [installation instructions](http://gpoddernet.readthedocs.io/en/latest/dev/installation.html) for details.
18 Bugs
19 ----
20 Please report bugs in the [GitHub issue tracker](https://github.com/gpodder/mygpo/issues).
23 Contributing
24 ------------
25 gpodder.net is an open source project and your contributions are wanted and appreciated.  To get started please see the [developer documentation](http://gpoddernet.readthedocs.io/en/latest/dev/index.html).
28 Mailing List
29 ------------
30 mygpo and gpodder.net related issues are discussed on the [gPodder Mailing List](https://gpodder.github.io/docs/mailing-list.html).
33 Documentation
34 -------------
35 Documentation, especially for the API, is stored in the [**doc** folder](https://github.com/gpodder/mygpo/tree/master/doc) and can be read on [ReadTheDocs](http://gpoddernet.readthedocs.io/en/latest/index.html).
38 Name (Why mygpo?)
39 ------------------
40 mygpo is a short version of "my.gpodder.org" which was the old [domain] name of gpodder.net and has been used as the project name since then.