Skip to content

Commit

Permalink
Merge pull request #13 from ZIMO-Elektronik/esp32_docs
Browse files Browse the repository at this point in the history
docs: add ESP32 to build section
  • Loading branch information
higaski committed May 7, 2024
2 parents 9fc5d93 + 1e35517 commit f957a56
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ FetchContent_Declare(
target_link_libraries(YourTarget PRIVATE DCC::DCC)
```

or, on [ESP platforms](https://www.espressif.com/en/products/socs/esp32), with the [IDF Component Manager](https://docs.espressif.com/projects/idf-component-manager/en/latest/) by adding it to a `idf_component.yml` file.
or, on [ESP32 platforms](https://www.espressif.com/en/products/socs/esp32), with the [IDF Component Manager](https://docs.espressif.com/projects/idf-component-manager/en/latest/) by adding it to a `idf_component.yml` file.
```yaml
dependencies:
zimo-elektronik/dcc:
Expand Down Expand Up @@ -187,6 +187,11 @@ dcc> Address 3: set speed 18
```

#### ESP32
On [ESP32 platforms](https://www.espressif.com/en/products/socs/esp32) examples from the [examples](https://github.com/ZIMO-Elektronik/DCC/raw/master/examples) subfolder can be built directly using the [IDF Frontend](https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-guides/tools/idf-py.html).

```sh
idf.py create-project-from-example "zimo-elektronik/dcc^0.34.0:esp32"
```

#### STM32
An example that runs on [STM32](https://www.st.com/en/microcontrollers-microprocessors/stm32-32-bit-arm-cortex-mcus.html) platforms is a decoder and command station pair for a [NUCLEO-H743ZI](https://www.st.com/en/evaluation-tools/nucleo-h743zi.html) development board.
Expand Down

0 comments on commit f957a56

Please sign in to comment.