Skip to content
Snippets Groups Projects
Commit d9d56580 authored by Jens Nolte's avatar Jens Nolte
Browse files

Clarify script usage in readme

parent 338e54d5
No related branches found
No related tags found
No related merge requests found
......@@ -6,12 +6,12 @@
* `git submodule update --init --recursive`
* Create `environments/<my_environment>.h` (see/copy the example file)
* Create `devices/<my_device>` directory (see/copy the example device)
* Run `./set-environment <my_environment>` to set a target environment
* Run `./set-device <my_device>` to set a target device
* Run `./set-environment <my_environment>` (or `./set-environment <path_to_environment_file.h>`) to set a target environment
* Run `./set-device <my_device>` (or `./set_device <path_to_device_directory>`) to set a target device
* Run `./make flash` (or `./make flash monitor`) to build and flash your device
## esp-idf notes
This project includes the esp-idf as a submodule. Use the included script (`./make`) to invoke the toolchain or set your `IDF_PATH` to the projects `esp-idf` directory to avoid version conflicts.
## Disclaimer
The API is not stable
\ No newline at end of file
The API is not stable
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment