Compare commits

...

3 Commits

Author SHA1 Message Date
rkcf f960dba5a8 Docs: add project setup section to README 2023-02-20 08:18:05 -06:00
rkcf 3287956c5d Docs: add contributing and license sections to README 2023-02-20 08:14:08 -06:00
rkcf 6945c7bc0c Add: LICENSE 2023-02-20 08:13:34 -06:00
2 changed files with 45 additions and 1 deletions

7
LICENSE Normal file
View File

@ -0,0 +1,7 @@
Copyright © 2023 Andrew Steinke <rkcf@rkcf.me>
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

View File

@ -11,3 +11,40 @@ 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
* Project Setup
Clone the repository over ssh.
#+BEGIN_SRC shell
git clone git@gitea.rkcf.me/rkcf/esp32_eurorack_generic.git
cd esp32_eurorack_generic
#+END_SRC
Source idf path. Assumes [[https://docs.espressif.com/projects/esp-idf/en/v5.0/esp32s3/get-started/index.html#installation][ESP-IDF]] properly configured on system.
#+BEGIN_SRC shell
. $YOUR_PATH_TO_ESP_IDF/export.sh
#+END_SRC
Set the target chip and configure the project. NOTE: Running menuconfig is not currently necessary for this project.
#+BEGIN_SRC shell
idf.py set-target esp32s3
idf.py menuconfig
#+END_SRC
Building and flashing the project. Where $PORT is the boards serial port system address (e.g. /dev/ttyUSB0).
#+BEGIN_SRC shell
idf.py build
idf.py -p $PORT flash
idf.py -p $PORT monitor
#+END_SRC
Or do all of this in one go with:
#+BEGIN_SRC shell
idf.py -p $PORT flash monitor
#+END_SRC
* 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]]