diff --git a/README.md b/README.md index b1db7ad..950fa4f 100644 --- a/README.md +++ b/README.md @@ -27,7 +27,7 @@ samples and therefore no precise sync could be achieved. ### Codebase -The codebase is split into components and build on ESP-IDF v4.3.1. I still +The codebase is split into components and build on ESP-IDF v4.3.5. I still have some refactoring on the todo list as the concept has started to settle and allow for new features can be added in a structured manner. In the code you will find parts that are only partly related features and still not on the task @@ -181,6 +181,10 @@ Then on every `git commit`, a few sanity/formatting checks will be performed. - [ ] dsp_processor: add equalizer * Control interface for equalizer - [ ] clean and polish code (remove all unused variables etc.) +- [ ] Improve Documentation, e.g. Hardware guide (supported codecs) +- [ ] upgrade to IDF v5 +- [ ] in IDF v5 use native i2s driver, as it supports preloading DMA buffer with valid data now +- [ ] Throw out ADF copied components from project tree and use CmakeLists.txt to pull in necessary files from ADF ## Minor task - [ok] soft mute - play sample in buffer with decreasing volume diff --git a/doc/docker_build.md b/doc/docker_build.md index 17e3295..396723f 100644 --- a/doc/docker_build.md +++ b/doc/docker_build.md @@ -37,11 +37,11 @@ Write `build/firmware.bin` to ESP32 at address 0x0000 -------------------- ### More details ``` -docker run +docker run --rm // Removes container after exit -it // runs interactive terminal -v .:/project // maps current directory to /project in container -w /project // sets working directory inside a container to /project - espressif/idf:v4.3.1 // image name + version + espressif/idf:v4.3.5 // image name + version idf.py menuconfig // run menuconfig -``` \ No newline at end of file +```