You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+39-40Lines changed: 39 additions & 40 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,9 +8,33 @@
8
8
9
9
These HALs are `no_std`; if you are looking for `std` support, please use [esp-idf-hal] instead.
10
10
11
-
This project is still in the early stages of development, and as such there should be no expectation of API stability. A significant number of peripherals currently have drivers implemented (you can see a full list [here]) but have varying levels of functionality. For most basic tasks, this should be usable already.
11
+
If you have any questions, comments, or concerns, please [open an issue], [start a new discussion], or join us on [Matrix]. For additional information regarding any of the crates in this repository, please refer to the relevant crate's README.
12
12
13
-
If you have any questions, comments, or concerns, please [open an issue], [start a new discussion], or join us on [Matrix]. For additional information regarding any of the crates in this repository, please refer to the crate's README.
13
+
> **Note**
14
+
>
15
+
> This project is still in the relatively early stages of development, and as such there should be no expectation of API stability. A significant number of peripherals currently have drivers implemented but have varying levels of functionality. For most basic tasks, this should be usable already, however some more advanced or uncommon features may not yet be implemented.
If you have not already, we strongly encourage you to read [The Rust on ESP Book] prior to starting.
50
-
51
-
We recommend using [cargo-generate] and [esp-template] in order to generate a new project. This will allow you to generate a minimal project skeleton with all the required dependencies and configuration ready to go.
52
-
53
-
You can install [cargo-generate] and generate a new project by running:
54
-
55
-
```bash
56
-
$ cargo install cargo-generate
57
-
$ cargo generate -a esp-rs/esp-template
58
-
```
59
-
60
-
For more information on using this template, please refer to [its README].
61
-
62
-
[the rust on esp book]: https://esp-rs.github.io/book/
We provide a simple `pre-commit` hook to verify the formatting of each package prior to committing changes. We _strongly_ encourage use of this git hook.
91
+
92
+
The hook can be enabled by copying it in to the `.git/hooks/` directory:
93
+
94
+
```bash
95
+
cp pre-commit .git/hooks/pre-commit
96
+
```
97
+
98
+
When using this hook, you can choose to ignore its failure on a per-commit basis by committing with the `--no-verify` flag; however, you will need to be sure that all packages are formatted when submitting a pull request.
99
+
89
100
## MSRV
90
101
91
102
The **M**inimum **S**upported **R**ust **V**ersions are:
@@ -95,25 +106,13 @@ The **M**inimum **S**upported **R**ust **V**ersions are:
95
106
-`1.65.0` for Xtensa devices (**ESP32**, **ESP32-S2**, **ESP32-S3**)
96
107
-`1.67.0` for all `async` examples (`embassy_hello_world`, `embassy_wait`, etc.)
97
108
98
-
Note that targeting the Xtensa ISA currently requires the use of the [esp-rs/rust] compiler fork. Our recommend method of installation is [espup].
109
+
It should be noted that targeting the Xtensa ISA currently requires the use of the [esp-rs/rust] compiler fork. Our recommend method of installation is [espup].
99
110
100
111
RISC-V is officially supported by the official Rust compiler.
We provide a simple `pre-commit` hook to verify the formatting of each package prior to committing changes. We strongly encourage use of this git hook.
108
-
109
-
The hook can be enabled by placing it in the `.git/hooks/` directory:
110
-
111
-
```bash
112
-
$ cp pre-commit .git/hooks/pre-commit
113
-
```
114
-
115
-
When using this hook, you can choose to ignore its failure on a per-commit basis by committing with the `--no-verify` flag; however, you will need to be sure that all packages are formatted when submitting a pull request.
0 commit comments