Skip to content

Commit 8dd9fec

Browse files
committed
Mention the libuv requirement in the README
1 parent 0d8dddd commit 8dd9fec

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,28 @@ Please see the [espflash README] for more information.
4747
$ espflash /dev/ttyUSB0 target/xtensa-esp32-none-elf/release/examples/blinky
4848
```
4949

50+
## Notes on Building
51+
52+
In order to build from source, in addition to the Rust toolchain [libuv](https://libuv.org/) must be present on your system. This can be installed via most popular package managers.
53+
54+
### macOS
55+
56+
```bash
57+
$ brew install libuv
58+
```
59+
60+
### Ubuntu
61+
62+
```bash
63+
$ sudo apt-get install libuv-dev
64+
```
65+
66+
### Fedora
67+
68+
```bash
69+
$ dnf install systemd-devel
70+
```
71+
5072
## Quickstart - Docker
5173

5274
The `esprs/espflash` Docker image contains all necessary toolchains and tooling (including espflash) to build an application and flash it to a target device.

0 commit comments

Comments
 (0)