diff --git a/README.md b/README.md new file mode 100644 --- /dev/null +++ b/README.md @@ -0,0 +1,21 @@ +# Protofusion ESP32S3 Template + +## Configure +Run menuconfig with `idf.py menuconfig` and choose the Protofusion menu option. + +Set target with `idf.y set-target esp32s3` + +Rename the project by editing CMakeLists.txt and change `project(protofusion_template)` to reflect your project name + +Note that clean doesn't always clean everything... do `idf.py fullclean` to make sure all generated files are removed (especially when switching processors). + +## Build and Flash + +Build the project and flash it to the board, then run monitor tool to view serial output: + +```bash +idf.py flash monitor +``` + +(To exit the serial monitor, type ``Ctrl-]``.) +