.gitignore

@@ -3,6 +3,7 @@
 # https://github.com/espressif/esp-idf
 
 build/
+sdkconfig
 sdkconfig.old
 
 .idea

README.md

@@ -1,23 +1,38 @@
 # HyperLink_SW
 
-Firmware for the HyperLink project.
+Firmware for the HyperLink board.
 
 ## Build and run
 
-This project is built using the
+This project is built using the [ESP IDF](https://docs.espressif.com/projects/esp-idf/en/release-v5.1/esp32/index.html) toolchain.
-[ESP IDF](https://docs.espressif.com/projects/esp-idf/en/release-v5.1/esp32/index.html)
+In order to ease the build process, a custom `Dockerfile` is provided.
-toolchain. In order to ease the build process, a custom `Dockerfile` is
+Any ESP IDF toolchain command can be run by replacing `idf.py` by `./idf.sh`, e.g., `./idf.sh build`,
-provided. Any ESP IDF toolchain command can be run by replacing `idf.py` by
+after having built the docker image.
-`./idf.sh`, e.g., `./idf.sh build`.
 
-Before the executing the following commands, make sure the docker daemon is
+As the docker container has to be able to access the serial device for flashing,
-running:
+some configuration may have to take place.
+Make sure the `USB_GUID` and `USB_DEV` in `idf.py` have the correct values.
 
-1. Build the project
+1. Build the docker image
-   ```bash
+    ```bash
-   $ ./idf.sh build
+    $ sudo docker build . --tag hyperlink
-   ```
+    ```
-1. Flash the executable
+
-   ```bash
+2. Compile the project
-   $ ./idf.sh flash monitor
+    ```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)

idf.sh

@@ -35,4 +35,4 @@ done
 #
 
 
-docker build . && docker run ${DEVICE_FLAGS} --rm --user $(id -u):${USB_GID} -v $PWD:/project -w /project -it $(docker build . -q) idf.py $@
+docker run ${DEVICE_FLAGS} --rm --user $(id -u):${USB_GID} -v $PWD:/project -w /project -it hyperlink idf.py $@