Skip to content
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 3 commits into from
Dec 4, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/support.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ jobs:
action:
runs-on: ubuntu-latest
steps:
- uses: dessant/support-requests@v3
- uses: dessant/support-requests@v4
with:
github-token: ${{ github.token }}
support-label: 'support'
Expand Down
8 changes: 8 additions & 0 deletions CODE_OF_CONDUCT.md
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).

6 changes: 6 additions & 0 deletions CONTACT.md
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.
67 changes: 67 additions & 0 deletions CONTRIBUTING.md
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!
31 changes: 31 additions & 0 deletions FAQ.md
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.
Comment on lines +29 to +31
Copy link
Member

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!

Loading
Loading