Update and rename README.rst to README.md

tito · web-flow · commit 20acf8e122d6 · 2019-02-03T00:16:47.000+01:00
diff --git a/README.md b/README.md
@@ -1,10 +1,9 @@
 python-for-android
 ==================
 
-|Build Status|
-
-.. |Build Status| image:: https://secure.travis-ci.org/kivy/python-for-android.png?branch=master
-   :target: https://travis-ci.org/kivy/python-for-android
+[![Build Status](https://travis-ci.org/kivy/python-for-android.svg?branch=master)](https://travis-ci.org/kivy/python-for-android)
+[![Backers on Open Collective](https://opencollective.com/kivy/backers/badge.svg)](#backers) 
+[![Sponsors on Open Collective](https://opencollective.com/kivy/sponsors/badge.svg)](#sponsors) 
 
 python-for-android is a packager for Python apps on Android. You can
 create your own Python distribution including the modules and
@@ -27,45 +26,17 @@ For documentation and support, see:
 -  Mailing list: https://groups.google.com/forum/#!forum/kivy-users or
    https://groups.google.com/forum/#!forum/python-android.
 
-In 2015 these tools were rewritten to provide a new, easier to use and
-extend interface. If you are looking for the old toolchain with
-distribute.sh and build.py, it is still available at
-https://github.com/kivy/python-for-android/tree/old\_toolchain, and
-issues and PRs relating to this branch are still accepted. However, the
-new toolchain contains all the same functionality via the built in
-pygame bootstrap.
+## Documentation
 
-In the last quarter of 2018 the python recipes has been changed, the new recipe
-for python3 (3.7.1) has a new build system which has been applied to the ancient
-python recipe, allowing us to bump the python2 version number to 2.7.15. This
-change, unifies the build process for both python recipes, and probably solve
-some issues detected over the years, but unfortunately, this change breaks the
-pygame bootstrap (in a near future we will fix it or remove it). Also should be
-mentioned that the old python recipe is still usable, and has been renamed to
-`python2legacy`. This `python2legacy` recipe allow us to build with a minimum
-api lower than 21, which is not the case for the new python recipes which are
-limited to a minimum api of 21. All this work has been done using android ndk
-version r17c, and your build should success with that version...but be aware
-that the project is in constant development so...the ndk version will change
-at some time.
-
-Those mentioned changes has been done this way to make easier the transition
-between python3 and python2. We will slowly phase out python2 support
-towards 2020...so...if you are using python2 in your projects you should
-consider to migrate it into python3.
-
-Documentation
-=============
-
-Follow the `quickstart
-instructions <https://python-for-android.readthedocs.org/en/latest/quickstart/>`__
+Follow the [quickstart
+instructions](<https://python-for-android.readthedocs.org/en/latest/quickstart/>)
 to install and begin creating APKs.
 
-Quick instructions to start would be::
+Quick instructions to start would be:
 
     pip install python-for-android
 
-or to test the master branch::
+or to test the master branch:
 
     pip install git+https://github.com/kivy/python-for-android.git
 
@@ -79,28 +50,26 @@ This should return a list of recipes available to be built.
 To build any distributions, you need to set up the Android SDK and NDK
 as described in the documentation linked above.
 
-If you did this, to build an APK with SDL2 you can try e.g.::
+If you did this, to build an APK with SDL2 you can try e.g.:
 
     p4a apk --requirements=kivy --private /home/asandy/devel/planewave_frozen/ --package=net.inclem.planewavessdl2 --name="planewavessdl2" --version=0.5 --bootstrap=sdl2
 
-For full instructions and parameter options, see `the
-documentation <https://python-for-android.readthedocs.io/en/latest/quickstart/#usage>`__.
+For full instructions and parameter options, see [the
+documentation](https://python-for-android.readthedocs.io/en/latest/quickstart/#usage).
 
-Support
-=======
+## Support
 
 If you need assistance, you can ask for help on our mailing list:
 
 -  User Group: https://groups.google.com/group/kivy-users
 -  Email: kivy-users@googlegroups.com
 
-We also have `#support Discord channel <https://chat.kivy.org/>`_.
+We also have [#support Discord channel](https://chat.kivy.org/).
 
-Contributing
-============
+## Contributing
 
 We love pull requests and discussing novel ideas. Check out our
-`contribution guide <http://kivy.org/docs/contribute.html>`__ and feel
+[contribution guide](http://kivy.org/docs/contribute.html) and feel
 free to improve python-for-android.
 
 The following mailing list and IRC channel are used exclusively for
@@ -109,10 +78,67 @@ discussions about developing the Kivy framework and its sister projects:
 -  Dev Group: https://groups.google.com/group/kivy-dev
 -  Email: kivy-dev@googlegroups.com
 
-We also have `#dev Discord channel <https://chat.kivy.org/>`_.
+We also have [#dev Discord channel](https://chat.kivy.org/).
 
-License
-=======
+## License
 
 python-for-android is released under the terms of the MIT License.
 Please refer to the LICENSE file.
+
+## History
+
+In 2015 these tools were rewritten to provide a new, easier to use and
+extend interface. If you are looking for the old toolchain with
+distribute.sh and build.py, it is still available at
+https://github.com/kivy/python-for-android/tree/old_toolchain, and
+issues and PRs relating to this branch are still accepted. However, the
+new toolchain contains all the same functionality via the built in
+pygame bootstrap.
+
+In the last quarter of 2018 the python recipes has been changed, the new recipe
+for python3 (3.7.1) has a new build system which has been applied to the ancient
+python recipe, allowing us to bump the python2 version number to 2.7.15. This
+change, unifies the build process for both python recipes, and probably solve
+some issues detected over the years, but unfortunately, this change breaks the
+pygame bootstrap (in a near future we will fix it or remove it). Also should be
+mentioned that the old python recipe is still usable, and has been renamed to
+`python2legacy`. This `python2legacy` recipe allow us to build with a minimum
+api lower than 21, which is not the case for the new python recipes which are
+limited to a minimum api of 21. All this work has been done using android ndk
+version r17c, and your build should success with that version...but be aware
+that the project is in constant development so...the ndk version will change
+at some time.
+
+Those mentioned changes has been done this way to make easier the transition
+between python3 and python2. We will slowly phase out python2 support
+towards 2020...so...if you are using python2 in your projects you should
+consider to migrate it into python3.
+
+## Contributors
+
+This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)].
+<a href="https://github.com/kivy/python-for-android/graphs/contributors"><img src="https://opencollective.com/kivy/contributors.svg?width=890&button=false" /></a>
+
+
+## Backers
+
+Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/kivy#backer)]
+
+<a href="https://opencollective.com/kivy#backers" target="_blank"><img src="https://opencollective.com/kivy/backers.svg?width=890"></a>
+
+
+## Sponsors
+
+Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/kivy#sponsor)]
+
+<a href="https://opencollective.com/kivy/sponsor/0/website" target="_blank"><img src="https://opencollective.com/kivy/sponsor/0/avatar.svg"></a>
+<a href="https://opencollective.com/kivy/sponsor/1/website" target="_blank"><img src="https://opencollective.com/kivy/sponsor/1/avatar.svg"></a>
+<a href="https://opencollective.com/kivy/sponsor/2/website" target="_blank"><img src="https://opencollective.com/kivy/sponsor/2/avatar.svg"></a>
+<a href="https://opencollective.com/kivy/sponsor/3/website" target="_blank"><img src="https://opencollective.com/kivy/sponsor/3/avatar.svg"></a>
+<a href="https://opencollective.com/kivy/sponsor/4/website" target="_blank"><img src="https://opencollective.com/kivy/sponsor/4/avatar.svg"></a>
+<a href="https://opencollective.com/kivy/sponsor/5/website" target="_blank"><img src="https://opencollective.com/kivy/sponsor/5/avatar.svg"></a>
+<a href="https://opencollective.com/kivy/sponsor/6/website" target="_blank"><img src="https://opencollective.com/kivy/sponsor/6/avatar.svg"></a>
+<a href="https://opencollective.com/kivy/sponsor/7/website" target="_blank"><img src="https://opencollective.com/kivy/sponsor/7/avatar.svg"></a>
+<a href="https://opencollective.com/kivy/sponsor/8/website" target="_blank"><img src="https://opencollective.com/kivy/sponsor/8/avatar.svg"></a>
+<a href="https://opencollective.com/kivy/sponsor/9/website" target="_blank"><img src="https://opencollective.com/kivy/sponsor/9/avatar.svg"></a>
+
