Cleaned up the README.

This commit is contained in:
Joe Kearney 2025-01-25 14:11:11 -06:00
parent 303e9e1dad
commit ba25d66fe0

View file

@ -2,12 +2,16 @@
## Overview
This is software for the [2024A](https://git.clubk.club/KTag/2024A-HW) based on the
This is software for the [2024A](https://git.ktag.clubk.club/Hardware/2024A-HW) "32ESPecial" based on the
[ESP-IDF](https://github.com/espressif/esp-idf/).
The primary documentation for the 32ESPecial is on the KTag website at https://ktag.clubk.club/Devices/32ESPecial/.
You can ask questions (and get answers!) about this software on the KTag forum at https://forum.ktag.clubk.club/c/software/.
## License: [AGPL-3.0-or-later](https://spdx.org/licenses/AGPL-3.0-or-later.html)
This software is part of the KTag project.
This software is part of the KTag project, a DIY laser tag game with customizable features and wide interoperability.
🛡️ <https://ktag.clubk.club> 🃞
@ -32,7 +36,7 @@ This software in turn makes use of the following open-source software libraries
| Name | Version | License ([SPDX](https://spdx.org/licenses/)) | URL
|----------------------------|--------:|--------------------------------------------------------------------------|---------------------------------------------
| SystemK | 1.0 | [AGPL-3.0-or-later](https://spdx.org/licenses/AGPL-3.0-or-later.html) | https://git.clubk.club/KTag/SystemK
| SystemK | 1.0 | [AGPL-3.0-or-later](https://spdx.org/licenses/AGPL-3.0-or-later.html) | https://git.ktag.clubk.club/Software/SystemK/
| ESP-IDF | 5.4.0 | [Apache-2.0](https://spdx.org/licenses/Apache-2.0.html) | https://github.com/espressif/esp-idf/
| espressif/button | 3.5.0 | [Apache-2.0](https://spdx.org/licenses/Apache-2.0.html) | https://components.espressif.com/components/espressif/button
| espressif/led_strip | 2.5.3 | [Apache-2.0](https://spdx.org/licenses/Apache-2.0.html) | https://components.espressif.com/components/espressif/led_strip
@ -40,4 +44,4 @@ This software in turn makes use of the following open-source software libraries
| espressif/mdns | 1.4.3 | [Apache-2.0](https://spdx.org/licenses/Apache-2.0.html) | https://components.espressif.com/components/espressif/mdns
| chmorgan/esp-audio-player | 1.0.7 | [Apache-2.0](https://spdx.org/licenses/Apache-2.0.html) | https://components.espressif.com/components/chmorgan/esp-audio-player
| esp-libhelix-mp3 | 1.0.3 | [Apache-2.0](https://spdx.org/licenses/Apache-2.0.html) | https://github.com/chmorgan/esp-libhelix-mp3
| libhelix-mp3 | f443079 | [RPSL](https://github.com/chmorgan/libhelix-mp3/blob/master/LICENSE.txt) | https://github.com/chmorgan/libhelix-mp3
| libhelix-mp3 | f443079 | [RPSL](https://github.com/chmorgan/libhelix-mp3/blob/master/LICENSE.txt) | https://github.com/chmorgan/libhelix-mp3/