Skip to content

Commit 3d8a7b2

Browse files
inclementinclement
committed
Fixed README
1 parent 4cca0ca commit 3d8a7b2

File tree

1 file changed

+44
-38
lines changed

1 file changed

+44
-38
lines changed

‎README.rst

Lines changed: 44 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,40 @@
1-
# python-for-android
1+
python-for-android
2+
==================
23

34
python-for-android is a packager for Python apps on Android. You can
45
create your own Python distribution including the modules and
5-
dependencies you want, and bundle it in an APK along with your own
6-
code.
6+
dependencies you want, and bundle it in an APK along with your own code.
77

88
Features include:
99

10-
- Support for building with both Python 2 and Python 3.
11-
- Different app backends including Kivy, PySDL2, and a WebView with
12-
Python webserver.
13-
- Automatic support for most pure Python modules, and built in support
14-
for many others, including popular dependencies such as numpy and
15-
sqlalchemy.
16-
- Multiple architecture targets, for APKs optimised on any given device.
10+
- Support for building with both Python 2 and Python 3.
11+
- Different app backends including Kivy, PySDL2, and a WebView with
12+
Python webserver.
13+
- Automatic support for most pure Python modules, and built in support
14+
for many others, including popular dependencies such as numpy and
15+
sqlalchemy.
16+
- Multiple architecture targets, for APKs optimised on any given
17+
device.
1718

1819
For documentation and support, see:
1920

20-
- Website: http://python-for-android.readthedocs.io
21-
- Mailing list: https://groups.google.com/forum/#!forum/kivy-users or
22-
https://groups.google.com/forum/#!forum/python-android.
21+
- Website: http://python-for-android.readthedocs.io
22+
- Mailing list: https://groups.google.com/forum/#!forum/kivy-users or
23+
https://groups.google.com/forum/#!forum/python-android.
2324

2425
In 2015 these tools were rewritten to provide a new, easier to use and
2526
extend interface. If you are looking for the old toolchain with
2627
distribute.sh and build.py, it is still available at
27-
https://github.com/kivy/python-for-android/tree/old_toolchain, and
28-
issues and PRs relating to this branch are still accepted. However,
29-
the new toolchain contains all the same functionality via the built in
28+
https://github.com/kivy/python-for-android/tree/old\_toolchain, and
29+
issues and PRs relating to this branch are still accepted. However, the
30+
new toolchain contains all the same functionality via the built in
3031
pygame bootstrap.
3132

32-
# Documentation
33+
Documentation
34+
=============
3335

34-
Follow the
35-
[quickstart instructions](https://python-for-android.readthedocs.org/en/latest/quickstart/)
36+
Follow the `quickstart
37+
instructions <https://python-for-android.readthedocs.org/en/latest/quickstart/>`__
3638
to install and begin creating APKs.
3739

3840
Quick instructions to start would be::
@@ -43,7 +45,7 @@ or to test the master branch::
4345

4446
pip install git+https://github.com/kivy/python-for-android.git
4547

46-
The executable is called `python-for-android` or `p4a` (both are
48+
The executable is called ``python-for-android`` or ``p4a`` (both are
4749
equivalent). To test that the installation worked, try
4850

4951
python-for-android recipes
@@ -57,40 +59,44 @@ If you did this, to build an APK with SDL2 you can try e.g.
5759

5860
p4a apk --requirements=kivy --private /home/asandy/devel/planewave_frozen/ --package=net.inclem.planewavessdl2 --name="planewavessdl2" --version=0.5 --bootstrap=sdl2
5961

60-
For full instructions and parameter options, see [the documentation](https://python-for-android.readthedocs.io/en/latest/quickstart/#usage).
62+
For full instructions and parameter options, see `the
63+
documentation <https://python-for-android.readthedocs.io/en/latest/quickstart/#usage>`__.
6164

62-
# Support
65+
Support
66+
=======
6367

6468
If you need assistance, you can ask for help on our mailing list:
6569

66-
* User Group: https://groups.google.com/group/kivy-users
67-
* Email: kivy-users@googlegroups.com
70+
- User Group: https://groups.google.com/group/kivy-users
71+
- Email: kivy-users@googlegroups.com
6872

6973
We also have an IRC channel:
7074

71-
* Server: irc.freenode.net
72-
* Port: 6667, 6697 (SSL only)
73-
* Channel: #kivy
75+
- Server: irc.freenode.net
76+
- Port: 6667, 6697 (SSL only)
77+
- Channel: #kivy
7478

75-
# Contributing
79+
Contributing
80+
============
7681

7782
We love pull requests and discussing novel ideas. Check out our
78-
[contribution guide](http://kivy.org/docs/contribute.html) and
79-
feel free to improve python-for-android.
83+
`contribution guide <http://kivy.org/docs/contribute.html>`__ and feel
84+
free to improve python-for-android.
8085

8186
The following mailing list and IRC channel are used exclusively for
8287
discussions about developing the Kivy framework and its sister projects:
8388

84-
* Dev Group: https://groups.google.com/group/kivy-dev
85-
* Email: kivy-dev@googlegroups.com
89+
- Dev Group: https://groups.google.com/group/kivy-dev
90+
- Email: kivy-dev@googlegroups.com
8691

8792
IRC channel:
8893

89-
* Server: irc.freenode.net
90-
* Port: 6667, 6697 (SSL only)
91-
* Channel: #kivy or #kivy-dev
94+
- Server: irc.freenode.net
95+
- Port: 6667, 6697 (SSL only)
96+
- Channel: #kivy or #kivy-dev
9297

93-
# License
98+
License
99+
=======
94100

95-
python-for-android is released under the terms of the MIT License. Please refer to the
96-
LICENSE file.
101+
python-for-android is released under the terms of the MIT License.
102+
Please refer to the LICENSE file.

0 commit comments

Comments
 (0)