Skip to content

Commit 4fdf1ab

Browse files
committed
docs: mention required build tools, use Ninja by default
1 parent 880aef4 commit 4fdf1ab

File tree

3 files changed

+20
-3
lines changed

3 files changed

+20
-3
lines changed

README.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,9 @@ This example contains the following parts:
6161
* [examples/blink/](examples/blink/) directory with an example project which blinks an LED.
6262

6363

64-
## Toolchain required
64+
## Prerequisites
65+
66+
### Cross-compiler
6567

6668
Download and install `riscv-none-elf-gcc` toolchain, for example from the [xPack project](https://github.com/xpack-dev-tools/riscv-none-elf-gcc-xpack/releases).
6769

@@ -71,6 +73,21 @@ Make sure the toolchain is added to your `PATH`.
7173

7274
A different RISC-V toolchain can also be used, in this case you need to adjust [toolchain-rv32.cmake](toolchain-rv32.cmake).
7375

76+
### Build tools
77+
78+
This example uses CMake. Make sure that CMake and your build system of choice (e.g., Ninja or GNU Make) are also added to your `PATH`.
79+
80+
### esptool.py
81+
82+
To flash binaries into the ESP32-C3, [esptool.py](https://github.com/espressif/esptool) is used.
83+
84+
If you have Python and pip installed, you can install esptool using:
85+
```bash
86+
pip install --user esptool
87+
```
88+
89+
Windows users may alternatively download a pre-built executable from the [releases](https://github.com/espressif/esptool/releases) page. These executables don't require Python to be installed.
90+
7491
## Building and running the examples
7592

7693
See README.md files in example directories for instructions:

examples/blink/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Attach an LED and a current limiting resistor between GPIO 2 and 3V3 pins of an
1111
```bash
1212
cd examples/blink
1313
mkdir build
14-
cmake -B build .
14+
cmake -B build -G Ninja .
1515
cmake --build build
1616
```
1717
You should get the following output at the end:

examples/hello_world/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
```bash
88
cd examples/hello_world
99
mkdir build
10-
cmake -B build .
10+
cmake -B build -G Ninja .
1111
cmake --build build
1212
```
1313
You should get the following output at the end:

0 commit comments

Comments
 (0)