Modify idf.sh and update README.md

.gitignore

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

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