From 7b48d7d04369975e26be3e20a32bd33e9940fbb9 Mon Sep 17 00:00:00 2001 From: Julian-o Date: Sat, 25 Nov 2023 23:33:12 +1100 Subject: [PATCH 1/2] 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 --- CODE_OF_CONDUCT.md | 8 +++++++ CONTRIBUTING.md | 11 +++++++++ LICENSE | 10 ++++---- README.md | 59 ++++++++++++++++++++++++++++++++++++++++++++++ README.rst | 10 -------- setup.py | 2 +- 6 files changed, 84 insertions(+), 16 deletions(-) create mode 100644 CODE_OF_CONDUCT.md create mode 100644 CONTRIBUTING.md create mode 100644 README.md delete mode 100644 README.rst diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..29d18fa --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -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). + diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..a0eccbf --- /dev/null +++ b/CONTRIBUTING.md @@ -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. + + diff --git a/LICENSE b/LICENSE index 1376aa3..4e35060 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2020 matham +Copyright (c) 2010-2023 Kivy Team and other contributors Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal @@ -9,13 +9,13 @@ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..7a8c923 --- /dev/null +++ b/README.md @@ -0,0 +1,59 @@ +# Kivy Pong Demo + + + +[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). \ No newline at end of file diff --git a/README.rst b/README.rst deleted file mode 100644 index 7f9cd2f..0000000 --- a/README.rst +++ /dev/null @@ -1,10 +0,0 @@ -Pong Demo -========= - -A Kivy demo app showing how to package the Pong demo app. - -For more information: https://kivy.github.io/kivy_pong_demo/ - -.. image:: https://github.com/matham/ceed/workflows/Python%20application/badge.svg - :target: https://github.com/kivy/kivy_pong_demo/actions - :alt: Github action status diff --git a/setup.py b/setup.py index 3a2d30e..696b80f 100644 --- a/setup.py +++ b/setup.py @@ -6,7 +6,7 @@ here = path.abspath(path.dirname(__file__)) -with open(path.join(here, 'README.rst'), encoding='utf-8') as f: +with open(path.join(here, 'README.md'), encoding='utf-8') as f: long_description = f.read() URL = 'https://github.com/kivy/kivy_pong_demo' From b4d9ac8ae06b4ef7a7b2724eb92a458990e08fb7 Mon Sep 17 00:00:00 2001 From: Julian-o Date: Sun, 26 Nov 2023 00:58:48 +1100 Subject: [PATCH 2/2] Contact document missed. --- CONTACT.md | 8 ++++++++ 1 file changed, 8 insertions(+) create mode 100644 CONTACT.md diff --git a/CONTACT.md b/CONTACT.md new file mode 100644 index 0000000..337d75c --- /dev/null +++ b/CONTACT.md @@ -0,0 +1,8 @@ +# Contacting the Kivy Team + +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.