Skip to content

Commit 958d742

Browse files
maximeborgeseldruin
authored andcommitted
README: rewrite based on stm32f1xx-hal
1 parent 70f4e7c commit 958d742

File tree

1 file changed

+46
-6
lines changed

1 file changed

+46
-6
lines changed

README.md

Lines changed: 46 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,59 @@
11
# `stm32f7xx-hal`
22

3+
> [HAL] for the STM32F7 family of microcontrollers
4+
5+
[HAL]: https://crates.io/crates/embedded-hal
6+
37
[![Crates.io - stm32f7xx-hal](https://img.shields.io/crates/v/stm32f7xx-hal.svg?maxAge=2592000)](https://crates.io/crates/stm32f7xx-hal)
48
[![Released API docs](https://docs.rs/stm32f7xx-hal/badge.svg)](https://docs.rs/stm32f7xx-hal)
59
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
610
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
711
[![CI](https://github.com/stm32-rs/stm32f7xx-hal/workflows/Continuous%20integration/badge.svg?branch=master)](https://github.com/stm32-rs/stm32f7xx-hal/actions)
812

9-
A Rust embedded-hal HAL for all MCUs in the STM32 F7 family.
10-
1113
This crate is largely inspired by the awesome work done here:
1214

13-
- [stm32f767-hal](https://github.com/therealprof/stm32f767-hal)
14-
- [stm32f103xx-hal](https://github.com/japaric/stm32f103xx-hal)
15-
- [embedded-hal](https://github.com/japaric/embedded-hal.git)
16-
- [stm32f4](https://crates.io/crates/stm32f4)
15+
- [stm32f1xx-hal](https://github.com/stm32-rs/stm32f1xx-hal)
16+
- [stm32f4xx-hal](https://github.com/stm32-rs/stm32f4xx-hal)
17+
18+
## Selecting a microcontroller
19+
20+
This crate supports multiple microcontrollers in the
21+
stm32f7 family. Which specific microcontroller you want to build for has to be
22+
specified with a feature, for example `stm32f767`.
23+
24+
If no microcontroller is specified, the crate will not compile.
25+
26+
### Supported Microcontrollers
27+
28+
* `stm32f722`
29+
* `stm32f723`
30+
* `stm32f730`
31+
* `stm32f732`
32+
* `stm32f733`
33+
* `stm32f745`
34+
* `stm32f746`
35+
* `stm32f756`
36+
* `stm32f765`
37+
* `stm32f767`
38+
* `stm32f769`
39+
* `stm32f777`
40+
* `stm32f778`
41+
* `stm32f779`
42+
43+
## Using as a Dependency
44+
45+
When using this crate as a dependency in your project, the microcontroller can
46+
be specified as part of the `Cargo.toml` definition.
47+
48+
```toml
49+
[dependencies.stm32f7xx-hal]
50+
version = "0.7.0"
51+
features = ["stm32f767", "rt"]
52+
```
53+
54+
## Documentation
55+
56+
The documentation can be found at [docs.rs/stm32f7xx-hal](https://docs.rs/stm32f7xx-hal/).
1757

1858
## License
1959

0 commit comments

Comments
 (0)