From 3287956c5de812c1344a26267dae59c2043c5585 Mon Sep 17 00:00:00 2001 From: rkcf Date: Mon, 20 Feb 2023 08:14:08 -0600 Subject: [PATCH] Docs: add contributing and license sections to README --- README.org | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/README.org b/README.org index bc42d0e..f7315b8 100644 --- a/README.org +++ b/README.org @@ -2,7 +2,7 @@ This project aims to create a generic esp32-s3 based eurorack modular unit—reprogramable to allow for multiple modular possibilities. -* Specs +* Specs - 18 HP - I/O - 4 channel input @@ -11,3 +11,10 @@ This project aims to create a generic esp32-s3 based eurorack modular unit—rep - 2 Rotary encoder switches - 4 buttons - 2.2in TFT LCD Display + +* Contributing +- Currently this branch is bleeding edge for rapid prototyping. In the future, a design will be homolugated and [[https://semver.org/][Semantic Versioning 2.0.0]] will be used. Note that schematics have their own versioning seperate from the code base. +- Commit messages should follow [[https:www.conventionalcommits.org/en/v1.0.0/][Conventional Commits 1.0.0]] + +* License +This project is licensed under the [[https://choosealicense.com/licenses/mit/][MIT License]]