Skip to content

Commit 6305082

Browse files
committed
Updated README ready to replace master branch
1 parent 99d7e93 commit 6305082

File tree

1 file changed

+28
-14
lines changed

1 file changed

+28
-14
lines changed

README.md

Lines changed: 28 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,22 @@
1-
# python-for-android revamp
1+
# Python for Android
22

3-
This is an experimental Python for Android APK builder based on the
4-
pythonic toolchain of kivy-ios. It is intended to replace the current
5-
python-for-android toolchain, but to be significantly better. Broad goals include:
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.
6+
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 PRs
11+
to this branch are still accepted.
12+
13+
For documentation and support, see:
14+
15+
- Website: http://python-for-android.rtfd.org/
16+
- Forum: https://groups.google.com/forum/?hl=fr#!forum/python-android
17+
- Mailing list: python-android@googlegroups.com
18+
19+
Broad goals of the revamp project include:
620

721
- ✓ Replace the old toolchain with a more extensible pythonic one
822
- ✓ Support SDL2
@@ -13,13 +27,10 @@ python-for-android toolchain, but to be significantly better. Broad goals includ
1327
- ✓ Be a standalone Pypi module (not on pypi yet but setup.py works)
1428
- Support multiple architectures
1529

16-
This is at an early (but working!) stage; the new toolchain has been
17-
fully written (save for clearing up bugs and non-essential features),
18-
and the toolchain supports both SDL2 and Pygame backends. The other
19-
features will be tackled soon.
20-
2130
We are currently working to stabilise all parts of the toolchain and
22-
add more features. Testing is welcome.
31+
add more features. Support for pygame-based APKs is almost feature
32+
complete with the old toolchain. Testing and contributions are
33+
welcome.
2334

2435
# TODO to make this the master branch
2536

@@ -30,8 +41,8 @@ add more features. Testing is welcome.
3041

3142
Steps to make this the master branch will be:
3243

33-
1. Copy p4a master to a new 'old_toolchain' branch
34-
2. Merge https://github.com/kivy/buildozer/pull/233 so that buildozer
44+
1. Copy p4a master to a new 'old_toolchain' branch
45+
2. Merge https://github.com/kivy/buildozer/pull/233 so that buildozer
3546
will pull from this branch
3647
3. Push a new buildozer version to pypi. It is important that people
3748
will be able to upgrade!
@@ -44,7 +55,9 @@ Steps to make this the master branch will be:
4455
# Documentation
4556

4657
This toolchain is documented (temporarily)
47-
[here](http://inclem.net/files/p4a_revamp_doc/).
58+
[here](http://inclem.net/files/p4a_revamp_doc/). Follow the
59+
[quickstart instructions](http://inclem.net/files/p4a_revamp_doc/quickstart.html#quickstart)
60+
to install and begin creating APK.
4861

4962
Quick instructions to start would be:
5063

@@ -92,7 +105,8 @@ the reference commit that the revamp is based on:
92105

93106
# Current status
94107

95-
The tool works, testing is welcomed. Doc is available [here](http://inclem.net/files/p4a_revamp_doc/).
108+
The tool works, testing is welcomed. Doc is available
109+
[here](http://inclem.net/files/p4a_revamp_doc/).
96110

97111
# Development notes
98112

0 commit comments

Comments
 (0)