From 062e4b3cdc5dd8147e13e579612d13cbf57e810c Mon Sep 17 00:00:00 2001 From: s-martin Date: Tue, 13 Feb 2024 16:25:57 +0000 Subject: [PATCH] fix formatting and link to future3 docs --- CODE_OF_CONDUCT.md | 3 ++- CONTRIBUTING.md | 3 ++- README.md | 13 ++++++------- 3 files changed, 10 insertions(+), 9 deletions(-) diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index dfd857be8..61119ba88 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -1,6 +1,7 @@ # Contributor Covenant Code of Conduct -> 📝**NOTE:** Dear Phonieboxians, as the Phoniebox community is growing, somebody suggested a pull request with the below document. I was hesitant to include it right away, but at the same time I thought: it might be good to have some kind of document to formulate the foundation this project is built on. To tell you the truth, this document is not it. However, it is a start and I thought: why not open this in the spirit of open source, sharing and pull requests and see if and how you or you or you want to change or add parts of this very *standard and corporate* document. Like most of you, I also have a small kid and my time is scarce, I might find some time though to add a bit. **All the best, Micz**, 2018-08-21 +> [!NOTE] +> Dear Phonieboxians, as the Phoniebox community is growing, somebody suggested a pull request with the below document. I was hesitant to include it right away, but at the same time I thought: it might be good to have some kind of document to formulate the foundation this project is built on. To tell you the truth, this document is not it. However, it is a start and I thought: why not open this in the spirit of open source, sharing and pull requests and see if and how you or you or you want to change or add parts of this very *standard and corporate* document. Like most of you, I also have a small kid and my time is scarce, I might find some time though to add a bit. **All the best, Micz**, 2018-08-21 This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version] diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 889233f70..6ac2d37c6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,7 @@ # Contributing -> 📝**NOTE:** This describes contributing for **version 2.x**. For Version 3 please see +> [!NOTE] +> This describes contributing for **version 2.x**. For Version 3 please see ## How to contribute diff --git a/README.md b/README.md index e32387cd6..d2ace6f73 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,6 @@ [![Gitter chat](https://badges.gitter.im/join_chat.svg)](https://matrix.to/#/#phoniebox_community:gitter.im) [![Matrix chat](https://matrix.to/img/matrix-badge.svg)](https://matrix.to/#/#phoniebox_community:gitter.im) - ## Introduction Phoniebox is a contactless jukebox for the Raspberry Pi, playing audio files, playlists, podcasts, web streams and spotify triggered by RFID cards. All plug and play via USB, no soldering iron needed. It also features GPIO buttons control support. @@ -39,7 +38,7 @@ If you want to be featured on next years calendar, please make sure to add your ### 🔥 Version 3 is coming -The goal for Version 3 was to tidy up the codebase, focus on a single programming language for the core (Python), establish a solid plugin system and build a responsive web client. [Read on here if you want to learn about more reasons](https://github.com/MiczFlor/RPi-Jukebox-RFID/blob/future3/develop/documentation/README.md). +The goal for Version 3 was to tidy up the codebase, focus on a single programming language for the core (Python), establish a solid plugin system and build a responsive web client. [Read on here if you want to learn about more reasons](https://github.com/MiczFlor/RPi-Jukebox-RFID/blob/future3/main/documentation/README.md). #### 👋 Looking for adopters, testers and contributors @@ -66,11 +65,11 @@ If you seek the adventure, your support will be more then welcome. Before contri Check out the following references. - * ⭐ **[Releases](https://github.com/MiczFlor/RPi-Jukebox-RFID/releases?q=v2&expanded=true)** - * 🚀 **[Install Jukebox Version 2](#quick-install-version-2)** - * 🐛 [Report a bug](https://github.com/MiczFlor/RPi-Jukebox-RFID/issues/new?assignees=&labels=bug%2C+needs+triage&projects=&template=bug_template.md&title=%F0%9F%90%9B+%7C+BUG+SUMMARY) - * ☑️ [Features](#features-version-2) - * 📖 [Documentation](#documentation) +* ⭐ **[Releases](https://github.com/MiczFlor/RPi-Jukebox-RFID/releases?q=v2&expanded=true)** +* 🚀 **[Install Jukebox Version 2](#quick-install-version-2)** +* 🐛 [Report a bug](https://github.com/MiczFlor/RPi-Jukebox-RFID/issues/new?assignees=&labels=bug%2C+needs+triage&projects=&template=bug_template.md&title=%F0%9F%90%9B+%7C+BUG+SUMMARY) +* ☑️ [Features](#features-version-2) +* 📖 [Documentation](#documentation) #### Features Version 2