-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Make doc structure consistent and up-to-date
This is part of an effort to make the Kivy sibling projects's documentation structure consistent and up-to-date. CHECKLIST * CONTRIBUTING.md [x] If repo takes user contributions, is present [x] In root dir (not .github dir) [x] Refers to kivy/kivy Contribution Guidelines. * LICENSE [x] If repo takes user contributions, is present. [x] Acknowledges the range of years to 2023. [x] Acknowledges Kivy Team and other contributors [x] Mentions it is an MIT License. * CODE_OF_CONDUCT.md [x] If repo takes user contributions or hosts discussions, is present. [x] Refers to kivy/kivy CODE_OF_CONDUCT * CONTACT.md [x] Refers to kivy/kivy CONTACT.md * FAQ.md [NA] If repo is big enough for RST documentation, is present. * README: [x] Is a Markdown file. [x] Describes the project. [x] Describes its place in the Kivy sibling projects. [x] If CONTRIBUTING exists, mentions it. [x] If LICENSE exists, mentions it. [x] If CODE_OF_CONDUCT exists, mentions it. [x] Mentions kivy/kivy CONTACT.md [NA] Uses Python syntax colouring for embedded Python code. [x] Uses badges to display current status. * RST documentation, if present [NA] Describes the project. [NA] Describes its place in the Kivy sibling projects. [NA] Mentions LICENSE. [NA] Mentions CONTRIBUTING [NA] Mentions CODE_OF_CONDUCT [NA] Mentions FAQ * WORKFLOWS [NA] NO_RESPONSE.yml is present if the repo has awaiting_reply tag. [NA] NO_RESPONSE uses latest script versions. [NA] SUPPORT.yml is present if the repo has a `support` tag. [NA] SUPPORT.yml refers to kivy/kivy CONTACT.md * setup.py/cfg, if present and on PyPI [NA] Supplies description to PyPI [NA] Supplies Python versions to PyPI [NA] Supplies Kivy/Kivy Code of Conduct to PyPI [NA] Supplies Contributing Guide to PyPI (local if different to kivy/kivy) [NA] Supplies Documentation, if any, to PyPI
- Loading branch information
Showing
6 changed files
with
84 additions
and
16 deletions.
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
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,11 @@ | ||
# Contribution Guidelines | ||
|
||
Kivy is a large product 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 | ||
[Kivy Contribution Guidelines](https://github.com/kivy/kivy/blob/master/CONTRIBUTING.md) | ||
for how you can help us. | ||
|
||
|
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,59 @@ | ||
# Kivy Pong Demo | ||
|
||
<img align="right" height="256" src="https://raw.githubusercontent.com/kivy/kivy/master/kivy/data/logo/kivy-icon-256.png"/> | ||
|
||
[Kivy](https://www.kivy.org) is an open-source [Python](https://python.org) framework | ||
for developing GUI apps that work cross-platform, including desktop, mobile and | ||
embedded platforms. | ||
|
||
It comes with a demo that shows how to code a simple game of | ||
[Pong](https://en.wikipedia.org/wiki/Pong). | ||
|
||
This repository is a demonstration of how to package the game, so it can be | ||
built for a number of platforms. | ||
|
||
[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](CODE_OF_CONDUCT.md) | ||
|
||
![PyPI - Version](https://img.shields.io/pypi/v/kivy_pong_demo) | ||
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/kivy_pong_demo) | ||
|
||
[![Build and Test Status](https://github.com/kivy/kivy_pong_demo/workflows/Python%20application/badge.svg)](https://github.com/kivy/kivy_pong_demo/actions) | ||
|
||
## License | ||
|
||
Kivy Pong Demo is [MIT licensed](LICENSE), actively developed by a great | ||
community and is supported by many projects managed by the | ||
[Kivy Organization](https://www.kivy.org/about.html). | ||
|
||
## Documentation | ||
|
||
[Documentation for this repository](https://kivy.github.io/kivy_pong_demo/) | ||
|
||
## Support | ||
|
||
Are you having trouble using the Kivy framework, or any of its related projects? | ||
Is there an error you don’t understand? Are you trying to figure out how to use | ||
it? We have volunteers who can help! | ||
|
||
The best channels to contact us for support are listed in the latest | ||
[Contact Us](https://github.com/kivy/kivy/blob/master/CONTACT.md) document. | ||
|
||
## Contributing | ||
|
||
Kivy is a large product 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 | ||
[Kivy Contribution Guidelines](https://github.com/kivy/kivy/blob/master/CONTRIBUTING.md) | ||
for how you can help us. | ||
|
||
## Code of Conduct | ||
|
||
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 was deleted.
Oops, something went wrong.
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