From dd2546ad8084f33e048e454ee5305d51240742ad Mon Sep 17 00:00:00 2001 From: staydata <130571429+staydata@users.noreply.github.com> Date: Thu, 12 Dec 2024 11:22:05 +0800 Subject: [PATCH] Update readme --- .github/workflows/main.yml | 17 ++++++++++++ README.md | 55 +++++++------------------------------- 2 files changed, 26 insertions(+), 46 deletions(-) create mode 100644 .github/workflows/main.yml diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml new file mode 100644 index 00000000..3fe2a29e --- /dev/null +++ b/.github/workflows/main.yml @@ -0,0 +1,17 @@ +on: + push: + branches: + - main + +jobs: + contrib-readme-job: + runs-on: ubuntu-latest + name: A job to automate contrib in readme + permissions: + contents: write + pull-requests: write + steps: + - name: Contribute List + uses: akhilmhdh/contributors-readme-action@v2.3.10 + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} \ No newline at end of file diff --git a/README.md b/README.md index fadb33f3..3f9d0c91 100644 --- a/README.md +++ b/README.md @@ -1,55 +1,18 @@ -

- -

+This is the development repository for the Zaparoo Core software. -- [Downloads](https://github.com/wizzomafizzo/tapto/releases/latest/) -- [TapTo Wiki](https://tapto.wiki/) -- [Discord](https://wizzo.dev/discord) -- [Developer Guide](docs/developers.md) -- [API Documentation](docs/api.md) -- [Contributors](#contributors) -- [Licenses](#licenses) - ---- - -TapTo is an open source system for launching games and scripted actions using physical objects like NFC cards. It's a great way to make playing games more accessible and add some fun to your gaming setup! - -This is the development repository for the core TapTo software. - -Want to get started with TapTo? Please visit the [TapTo Wiki](https://tapto.wiki/) for the latest information and guides. You can also [join the Discord](https://wizzo.dev/discord) if you need help. +Visit [Zaparoo.org](https://zaparoo.org/) for more information about the Zaparoo project and the [Downloads](https://zaparoo.org/) page for links to download Zaparoo Core for your platform. ## Contributors -TapTo has been a community effort from day one. Everyone's contributions are appreciated and encouraged! Want to contribute too? Check out the [Developer Guide](docs/developers.md). - -- **Aitor Gómez García** — developer — [GitHub](https://github.com/spark2k06) | [Ko-Fi](https://ko-fi.com/spark2k06) | [Web](https://aitorgomez.net/) | [Twitter](https://twitter.com/spark2k06) -- **Andrea Bogazzi** — developer — [GitHub](https://github.com/asturur) | [Sponsor](https://github.com/sponsors/asturur) | [Twitter](https://twitter.com/AndreaBogazzi) -- **ArielAces** — label designer — [Store](https://www.artisticpixels305.com/) | [Twitter](https://twitter.com/ArielAces) -- **batty** — writer — [GitHub](https://github.com/protogem2) | [Twitter](https://twitter.com/goddamnbathead) -- **BedroomNinja** — case designer — [Printables](https://www.printables.com/@bedroom_ninj_1665215) | [Store](https://ko-fi.com/ninja3dp) | [Twitter](https://twitter.com/Bedroom_Ninja) -- **Gaz** — developer — [GitHub](https://github.com/symm) | [Twitter](https://twitter.com/gazj) -- **Ranny Snice** — logo creator — [GitHub](https://github.com/Ranny-Snice) | [Patreon](https://www.patreon.com/RannySnice704) | [Twitter](https://twitter.com/RannySnice) -- **RetroCastle** — PCB designer — [Store](https://www.aliexpress.com/store/912024455) | [Twitter](https://twitter.com/zhangch93067765) -- **Sensorium** — C64 developer — [GitHub](https://www.github.com/SensoriumEmbedded) | [TeensyROM](https://github.com/SensoriumEmbedded/TeensyROM) | [Store](https://www.tindie.com/products/travissmith/teensyrom-cartridge-for-c64128/) | [Twitter](https://twitter.com/SensoriumEmb) -- **TheTrain** — PCB designer — [GP2040-CE GitHub](https://github.com/OpenStickCommunity/GP2040-CE) | [Twitter](https://twitter.com/thetrain24) -- **theypsilon** — developer — [GitHub](https://www.github.com/theypsilon) | [Patreon](https://www.patreon.com/theypsilon) | [Twitter](https://twitter.com/josembarroso) -- **Tim Wilsie** — UX designer — [GitHub](https://github.com/timwilsie) | [Twitter](https://twitter.com/timwilsie) -- **wizzo** — developer — [GitHub](https://github.com/wizzomafizzo) | [Patreon](https://patreon.com/wizzo) | [Store](https://ko-fi.com/wizzo) | [Web](https://wizzo.dev) | [Twitter](https://twitter.com/wizzomafizzo) -- **Ziggurat** — developer — [Github](https://github.com/sigboe) | [Paypal](https://paypal.me/sigboe156) - -Special thanks to **Gaz** for starting the project originally, and to **[javiwwweb](https://github.com/javiwwweb/MisTerRFID)** and **[Conner](https://github.com/ElRojo/MiSTerRFID)** for their existing MiSTerRFID projects. +See the [Contributors](https://wiki.zaparoo.org/Contributors) page for a complete list of all contributors to the Zaparoo project. Contributions are welcome and appreciated! -## Licenses + + -This project's source code is licensed under the [GNU General Public License v3](/LICENSE). +## Trademarks -The TapTo logo was designed by and is © Ranny Snice. The terms of use for the logo are as follows: +This repository contains Zaparoo trademarks which are explicitly licensed to the project in this location by the trademark owner. These trademarks must be removed from the project or replaced if you intend to redistribute or adapt the project in any form. See the Zaparoo [Terms of Use](https://zaparoo.org/terms/) for further details. -- The logo **MAY** be used on designs and artwork for tokens (e.g. label designs, printed stickers, pre-printed NFC cards), including those sold and held commercially, with the intent to show they're compatible with TapTo software and hardware. -- The logo **MAY** be used on open source community hardware. -- The logo **MAY** be used to link back to this repository or for similar promotional purposes of a strictly non-commercial nature (e.g. blog posts, social media, YouTube videos). -- The logo **MUST NOT** be used on or for the marketing of closed source or commercial hardware (e.g. case designs, PCBs), without express permission from the project. -- The logo **MUST NOT** be used for any other commercial products or purposes, without express permission from the project. -- The shape and overall design of the logo **MUST NOT** be modified or distorted. You **MAY** change the colors if required. +## License -Please contact the project if you are unsure about any of these licensing arrangements, or have any licensing requests. +The code in this repository is released under the [GNU General Public License v3.0](./LICENSE).