Docs: add contributing and license sections to README

main
rkcf 2023-02-20 08:14:08 -06:00
parent 6945c7bc0c
commit 3287956c5d
1 changed files with 8 additions and 1 deletions

View File

@ -2,7 +2,7 @@
This project aims to create a generic esp32-s3 based eurorack modular unit—reprogramable to allow for multiple modular possibilities. This project aims to create a generic esp32-s3 based eurorack modular unit—reprogramable to allow for multiple modular possibilities.
* Specs * Specs
- 18 HP - 18 HP
- I/O - I/O
- 4 channel input - 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 - 2 Rotary encoder switches
- 4 buttons - 4 buttons
- 2.2in TFT LCD Display - 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]]