diff --git a/README.md b/README.md index af1c67b..db587f0 100644 --- a/README.md +++ b/README.md @@ -13,8 +13,9 @@ Supports the ESP32, ESP32-C2/C3/C6, ESP32-H2, and ESP32-S2/S3. Currently `UART` To ease the building process we have included a `build` subcommand in the `xtask` package which will apply all the appropriate build configuration for one or more devices: ```bash -cargo xtask build esp32 -cargo xtask build esp32c2 esp32c3 +cd xtask/ +cargo run -- build esp32 +cargo run -- build esp32c2 esp32c3 ``` In order to build the flasher stub manually, you must specify the appropriate toolchain, provide a feature to `cargo` selecting the device, and additionally specify the target: @@ -45,8 +46,9 @@ cargo +esp build --release --features=esp32s3 --target=xtensa-esp32s3-none-elf In order to generate the JSON stub files for one or more devices, you can again use the `xtask` package: ```bash -cargo xtask wrap esp32c3 -cargo xtask wrap esp32 esp32s2 esp32s3 +cd xtask/ +cargo run -- wrap esp32c3 +cargo run -- wrap esp32 esp32s2 esp32s3 ``` JSON stub files will be generated in the project root directory. @@ -85,7 +87,7 @@ Then you can view logs using, for example `screen`: screen /dev/ttyUSB2 115200 ``` -> **Warning** +> [!WARNING] > > For ESP32 and ESP32-S2, please use a baud rate of 57,600 instead: >