-
Notifications
You must be signed in to change notification settings - Fork 508
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Make doc structure consistent and up-to-date #1750
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
In the interest of fostering an open and welcoming community, we as | ||
contributors and maintainers need to ensure participation in our project and | ||
our sister projects is a harassment-free and positive experience for everyone. | ||
It is vital that all interaction is conducted in a manner conveying respect, | ||
open-mindedness and gratitude. | ||
|
||
Please consult the [latest Kivy Code of Conduct](https://github.com/kivy/kivy/blob/master/CODE_OF_CONDUCT.md). | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
# Contacting the Kivy Team | ||
|
||
If you are looking to contact the Kivy Team (who are responsible for managing | ||
the Buildozer project), including looking for support, please see our | ||
latest [Contact Us](https://github.com/kivy/kivy/blob/master/CONTACT.md) | ||
document. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,67 @@ | ||
# Contribution Guidelines | ||
|
||
Buildozer is part of the [Kivy](https://kivy.org) ecosystem - a large group of | ||
products used by many thousands of developers for free, but it | ||
is built entirely by the contributions of volunteers. We welcome (and rely on) | ||
users who want to give back to the community by contributing to the project. | ||
|
||
Contributions can come in many forms. See the latest | ||
[Contribution Guidelines](https://github.com/kivy/kivy/blob/master/CONTRIBUTING.md) | ||
for general guidelines of how you can help us. | ||
|
||
--- | ||
|
||
If you would like to work on Buildozer, you can set up a development build: | ||
```bash | ||
git clone https://github.com/kivy/buildozer | ||
cd buildozer | ||
python setup.py build | ||
pip install -e . | ||
``` | ||
--- | ||
|
||
Buildozer uses python-for-android, that is architected to be extensible with | ||
new recipes and new bootstraps. | ||
|
||
If you do develop a new recipe on python-for-android, here is how to test it: | ||
|
||
#. Fork `Python for Android <https://github.com/kivy/python-for-android>`_, and | ||
clone your own version (this will allow easy contribution later):: | ||
|
||
```bash | ||
git clone https://github.com/YOURNAME/python-for-android | ||
``` | ||
|
||
#. Change your `buildozer.spec` to reference your version:: | ||
|
||
p4a.source_dir = /path/to/your/python-for-android | ||
|
||
#. Copy your recipe into `python-for-android/recipes/YOURLIB/recipe.sh` | ||
|
||
#. Rebuild. | ||
|
||
When your recipe works, you can ask us to | ||
include it in the python-for-android project, by issuing a Pull Request: | ||
|
||
#. Create a branch:: | ||
|
||
```bash | ||
git checkout --track -b recipe-YOURLIB origin/master | ||
``` | ||
|
||
#. Add and commit:: | ||
|
||
```bash | ||
git add python-for-android/recipes/YOURLIB/* | ||
git commit -am 'Add support for YOURLIB` | ||
``` | ||
|
||
#. Push to GitHub | ||
|
||
```bash | ||
git push origin master | ||
``` | ||
|
||
#. Go to `https://github.com/YOURNAME/python-for-android`, and you should see | ||
your new branch and a button "Pull Request" on it. Use it, write a | ||
description about what you did, and Send! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
# FAQ for Buildozer | ||
|
||
## Introduction | ||
|
||
Buildozer is a development tool for turning [Python](https://www.python.org/) | ||
applications into binary packages ready for installation on any of a number of | ||
platforms, including mobile devices. | ||
|
||
The app developer provides a single "buildozer.spec" file, which describes the | ||
application's requirements and settings, such as title and icons. Buildozer can | ||
then create installable packages for Android, iOS, Windows, macOS and/or Linux. | ||
|
||
Buildozer is managed by the [Kivy Team](https://kivy.org/about.html). It relies | ||
on its sibling projects: | ||
[python-for-android](https://github.com/kivy/python-for-android/) and | ||
[Kivy for iOS](https://github.com/kivy/kivy-ios/). It has features to make | ||
building apps using the [Kivy framework](https://github.com/kivy/kivy) easier, | ||
but it can be used independently - even with other GUI frameworks. | ||
|
||
## How do I write my own recipes? | ||
|
||
Instructions on how to write your own recipes is available in the | ||
[Kivy for iOS](https://github.com/kivy/kivy-ios/) and | ||
[python-for-android documentation](https://python-for-android.readthedocs.io/en/latest/recipes/). | ||
|
||
Instructions on how to test your own recipes from Buildozer is available in the | ||
[Buildozer Contribution Guidelines](CONTRIBUTING.md). | ||
|
||
> [!NOTE] | ||
> This document is very short at the moment. Please contribute some FAQ | ||
> questions and answers. | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Love this call to action!