8000 Updated README · yangjiu/python-for-android@35824bf · GitHub
[go: up one dir, main page]

Skip to content

Commit 35824bf

Browse files
committed
Updated README
1 parent fe5ff4e commit 35824bf

File tree

1 file changed

+29
-71
lines changed

1 file changed

+29
-71
lines changed

README.md

Lines changed: 29 additions & 71 deletions
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,33 @@
1-
# Python for Android
1+
# python-for-android
22

3-
Python for Android is a project to create your own Python distribution
4-
including the modules you want, and create an apk including python,
5-
libs, and your application.
3+
python-for-android is a packager for Python apps on Android. You can
4+
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.
67

7-
These tools were recently rewritten to provide a new, easier to use
8-
and extend interface. If you are looking for the old toolchain with
9-
distribute.sh and build.py, it is still available at
10-
https://github.com/kivy/python-for-android/tree/old_toolchain, and
11-
issues and PRs relating to this branch are still accepted. However,
12-
the new toolchain contains all the same functionality via the built in
13-
pygame bootstrap.
8+
python-for-android features include:
9+
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.
1417

1518
For documentation and support, see:
1619

17-
- Website: http://python-for-android.rtfd.org/
20+
- Website: http://python-for-android.readthedocs.io
1821
- Mailing list: https://groups.google.com/forum/#!forum/kivy-users or
1922
https://groups.google.com/forum/#!forum/python-android.
2023

21-
Broad goals of the revamp project include:
22-
23-
- ✓ Replace the old toolchain with a more extensible pythonic one
24-
- ✓ Support SDL2
25-
- ✓ Support multiple bootstraps (user-chosen java + NDK code, e.g. for
26-
multiple graphics backends or non-Kivy projects)
27-
- ✓ Support python3 (it finally works!)
28-
- (WIP) Support some kind of binary distribution, including on windows (semi-implemented, just needs finishing)
29-
- ✓ Be a standalone PyPI module (now available on PyPI!)
30-
- ✓ Support multiple architectures (full multiarch builds not complete, but arm and x86 with different config both work now)
31-
32-
We are currently working to stabilise all parts of the toolchain and
33-
add more features. Support for pygame-based APKs is almost feature
34-
complete with the old toolchain. Testing and contributions are
35-
welcome.
36-
37-
The recent replacement of the master branch with the revamp will have
38-
rendered most/all PRs invalid. Please retarget revamp PRs on the
39-
master branch, or PRs for the old toolchain on the old_toolchain
40-
branch.
24+
In 2015 these tools were rewritten to provide a new, easier to use and
25+
extend interface. If you are looking for the old toolchain with
10000 26+
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
30+
pygame bootstrap.
4131

4232
# Documentation
4333

@@ -67,39 +57,9 @@ If you did this, to build an APK with SDL2 you can try e.g.
6757

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

70-
For full instructions and parameter options, see the documentation
71-
linked above.
72-
73-
# Known missing stuff from P4A
74-
75-
Relating to all bootstraps:
76-
- Some recipes/components aren't stripped properly of doc etc.
77-
- Downloaded file md5 and headers aren't checked
78-
79-
Relating to SDL2 only:
80-
- Public dir installation
81-
- Keyboard height getter
82-
- Billing support
83-
- Kivy Launcher build (can now be implemented as a bootstrap...maybe?)
84-
- Probably some other stuff
85-
86-
Here are some specific things relating to changes in p4a itself since
87-
the reference commit that the revamp is based on:
88-
89-
# Current status
90-
91-
python-for-android is fully ready for use. We are working towards a versioned release.
92-
93-
# Development notes
94-
95-
Original reference commit of p4a master was
96-
7c8d4ce9db384528f7ea83e0841fe2464a558db8 - possibly some things after
97-
this need adding to the new toolchain. Some of the major later
98-
additons, including ctypes in the python build, have already been
99-
merged here.
60+
For full instructions and parameter options, see the documentation.
10061

101-
Support
102-
-------
62+
# Support
10363

10464
If you need assistance, you can ask for help on our mailing list:
10565

@@ -112,12 +72,11 @@ We also have an IRC channel:
11272
* Port: 6667, 6697 (SSL only)
11373
* Channel: #kivy
11474

115-
Contributing
116-
------------
75+
# Contributing
11776

11877
We love pull requests and discussing novel ideas. Check out our
11978
[contribution guide](http://kivy.org/docs/contribute.html) and
120-
feel free to improve Python for Android.
79+
feel free to improve python-for-android.
12180

12281
The following mailing list and IRC channel are used exclusively for
12382
discussions about developing the Kivy framework and its sister projects:
@@ -129,10 +88,9 @@ IRC channel:
12988

13089
* Server: irc.freenode.net
13190
* Port: 6667, 6697 (SSL only)
132-
* Channel: #kivy-dev
91+
* Channel: #kivy or #kivy-dev
13392

134-
License
135-
-------
93+
# License
13694

137-
Python for Android is released under the terms of the MIT License. Please refer to the
95+
python-for-android is released under the terms of the MIT License. Please refer to the
13896
LICENSE file.

0 commit comments

Comments
 (0)
0