Skip to content

Commit cbae96e

Browse files
committed
update readme
1 parent c540b05 commit cbae96e

File tree

1 file changed

+14
-10
lines changed

1 file changed

+14
-10
lines changed

README.md

+14-10
Original file line numberDiff line numberDiff line change
@@ -21,13 +21,21 @@ with ESP32 device. It is enough to write only web interface, without the need of
2121
(however Websockets work perfectly with Android and iOS native apps, Flutter apps etc).
2222

2323
The fact that it is based on Tokio and Rust opens all the existing ecosystem of Rust libraries for you.
24-
You can write tests and debug your app on desktop, before moving to mobile device.
24+
You can write tests and debug your app on desktop, before moving to mobile device.
2525

26-
## Install
26+
This configuration works on macOS and Linux, it will require minor changes to work on Windows.
2727

28-
Rust-ESP installation flow is described here, you need to follow all the required steps there:
28+
## Setup build environment
29+
30+
Install Rust on ESP build environment
2931
https://github.com/esp-rs/rust-build
3032

33+
Install latest NodeJS LTS
34+
https://nodejs.org/en/download
35+
36+
Install Yarn
37+
https://yarnpkg.com/getting-started/install
38+
3139
## Prepare
3240

3341
Copy `.env.default` to `.env` and change default values to the actual ones.
@@ -38,10 +46,6 @@ To prepare the build environment, execute the following command each time you op
3846

3947
## Build
4048

41-
On the first build, and also on each client change, run
42-
43-
`cd client && yarn && yarn build`
44-
4549
To build the project, use the following command:
4650

4751
`cargo build`
@@ -52,9 +56,9 @@ To run the project, use the following command:
5256

5357
## Reference links
5458

55-
* Rust-ESP installation process: https://github.com/esp-rs/rust-build
56-
* AXUM web framework: https://github.com/tokio-rs/axum
59+
* Rust-ESP installation process https://github.com/esp-rs/rust-build
60+
* Tokio.rs asynchronous runtime https://tokio.rs/tokio/tutorial
61+
* Axum web application framework https://github.com/tokio-rs/axum
5762
* Seeed Studio XIAO ESP32S3 https://wiki.seeedstudio.com/xiao_esp32s3_getting_started/
58-
* Tokio.rs asynchronous runtime documentation https://tokio.rs/tokio/tutorial
5963
* Awesome ESP Rust https://github.com/esp-rs/awesome-esp-rust
6064
* esp32-s3-rust-axum-example (used as a prototype for this project) https://github.com/aedm/esp32-s3-rust-axum-example/

0 commit comments

Comments
 (0)