Skip to content

Commit be98d3c

Browse files
committed
Overhaul README, add Getting Started section
1 parent 23be76c commit be98d3c

File tree

1 file changed

+37
-36
lines changed

1 file changed

+37
-36
lines changed

README.md

Lines changed: 37 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1,46 +1,47 @@
11
stm32f0xx-hal
22
=============
3+
34
[![Travis](https://img.shields.io/travis/stm32-rs/stm32f0xx-hal.svg)](https://travis-ci.org/stm32-rs/stm32f0xx-hal)
45
[![Crates.io](https://img.shields.io/crates/v/stm32f0xx-hal.svg)](https://crates.io/crates/stm32f0xx-hal)
56
[![docs.rs](https://docs.rs/stm32f0xx-hal/badge.svg)](https://docs.rs/stm32f0xx-hal/)
67

7-
_stm32f0xx-hal_ contains a hardware abstraction on top of the peripheral access
8-
API for the STMicro STM32F0xx family of microcontrollers. It replaces the
9-
[stm32f042-hal][] by a more ubiqitous version suitable for additional families.
10-
11-
Currently supported configuration are:
12-
* stm32f030
13-
* stm32f030x4
14-
* stm32f030x6
15-
* stm32f030x8
16-
* stm32f030xc
17-
* stm32f042
18-
* stm32f070
19-
* stm32f070x6
20-
* stm32f070xb
21-
* stm32f072
22-
* stm32f091
23-
24-
The idea behind this crate is to gloss over the slight differences in the
25-
various peripherals available on those MCUs so a HAL can be written for all
26-
chips in that same family without having to cut and paste crates for every
27-
single model.
28-
29-
Collaboration on this crate is highly welcome as are pull requests!
30-
31-
This crate relies on Adam Greigs fantastic [stm32f0][] crate to provide
32-
appropriate register definitions and implements a partial set of the
33-
[embedded-hal][] traits.
34-
35-
Some of the implementation was shamelessly adapted from the [stm32f103xx-hal][]
36-
crate by Jorge Aparicio.
37-
38-
[stm32f0]: https://crates.io/crates/stm32f0
39-
[stm32f042-hal]: https://github.com/therealprof/stm32f042-hal
40-
[stm32f103xx-hal]: https://github.com/japaric/stm32f103xx-hal
41-
[embedded-hal]: https://github.com/japaric/embedded-hal.git
8+
[_stm32f0xx-hal_](https://github.com/stm32-rs/stm32f0xx-hal) contains a hardware abstraction on top of the peripheral access API for the STMicro STM32F0xx family of microcontrollers.
9+
10+
This crate replaces the [stm32f042-hal](https://github.com/therealprof/stm32f042-hal) by a more ubiqitous version suitable for additional families. The idea behind this crate is to gloss over the slight differences in the various peripherals available on those MCUs so a HAL can be written for all chips in that same family without having to cut and paste crates for every single model.
11+
12+
This crate relies on Adam Greig's fantastic [stm32f0](https://crates.io/crates/stm32f0) crate to provide appropriate register definitions, and implements a partial set of the [embedded-hal](https://github.com/rust-embedded/embedded-hal) traits. Some of the implementation was shamelessly adapted from the [stm32f103xx-hal](https://github.com/japaric/stm32f103xx-hal) crate by Jorge Aparicio.
13+
14+
Collaboration on this crate is highly welcome, as are pull requests!
15+
16+
17+
Supported Configurations
18+
------------------------
19+
20+
* __stm32f030__ (stm32f030x4, stm32f030x6, stm32f030x8, stm32f030xc)
21+
* __stm32f042__
22+
* __stm32f070__ (stm32f070x6, stm32f070xb)
23+
* __stm32f072__
24+
* __stm32f091__
25+
26+
27+
Getting Started
28+
---------------
29+
30+
If you are unfamiliar with embedded development using Rust, there are a number of fantastic resources available to help.
31+
32+
- [Embedded Rust Documentation](https://docs.rust-embedded.org/)
33+
- [The Embedded Rust Book](https://docs.rust-embedded.org/book/)
34+
- [Rust Embedded FAQ](https://docs.rust-embedded.org/faq.html)
35+
- [rust-embedded/awesome-embedded-rust](https://github.com/rust-embedded/awesome-embedded-rust)
36+
37+
38+
Changelog
39+
---------
40+
41+
See [CHANGELOG.md](CHANGELOG.md).
42+
4243

4344
License
4445
-------
4546

46-
[0-clause BSD license](LICENSE-0BSD.txt).
47+
0-Clause BSD License, see [LICENSE-0BSD.txt](LICENSE-0BSD.txt) for more details.

0 commit comments

Comments
 (0)