diff --git a/README.md b/README.md index 76f4ca1..76e4c46 100644 --- a/README.md +++ b/README.md @@ -1,38 +1,23 @@ # HyperLink_SW -Firmware for the HyperLink board. +Firmware for the HyperLink project. ## Build and run -This project is built using the [ESP IDF](https://docs.espressif.com/projects/esp-idf/en/release-v5.1/esp32/index.html) toolchain. -In order to ease the build process, a custom `Dockerfile` is provided. -Any ESP IDF toolchain command can be run by replacing `idf.py` by `./idf.sh`, e.g., `./idf.sh build`, -after having built the docker image. +This project is built using the +[ESP IDF](https://docs.espressif.com/projects/esp-idf/en/release-v5.1/esp32/index.html) +toolchain. In order to ease the build process, a custom `Dockerfile` is +provided. Any ESP IDF toolchain command can be run by replacing `idf.py` by +`./idf.sh`, e.g., `./idf.sh build`. -As the docker container has to be able to access the serial device for flashing, -some configuration may have to take place. -Make sure the `USB_GUID` and `USB_DEV` in `idf.py` have the correct values. +Before the executing the following commands, make sure the docker daemon is +running: -1. Build the docker image - ```bash - $ sudo docker build . --tag hyperlink - ``` - -2. Compile the project - ```bash - $ ./idf.sh build - ``` - -3. Flash the executable - ```bash - $ ./idf.sh flash - ``` - -## Misc - -### CLion Docker Setup - -To configure the project to be built with docker in CLion, create a new docker -toolchain with the following settings: - -![image](doc/CLion_docker_settings_screenshot.png) \ No newline at end of file +1. Build the project + ```bash + $ ./idf.sh build + ``` +1. Flash the executable + ```bash + $ ./idf.sh flash monitor + ``` diff --git a/idf.sh b/idf.sh index 1688bfa..96fd298 100755 --- a/idf.sh +++ b/idf.sh @@ -35,4 +35,4 @@ done # -docker run ${DEVICE_FLAGS} --rm --user $(id -u):${USB_GID} -v $PWD:/project -w /project -it hyperlink idf.py $@ +docker build . && docker run ${DEVICE_FLAGS} --rm --user $(id -u):${USB_GID} -v $PWD:/project -w /project -it $(docker build . -q) idf.py $@