From 81d1565160e85455ccbad4460aa41520124c813e Mon Sep 17 00:00:00 2001 From: Mattia Maldini Date: Fri, 2 Aug 2019 17:46:14 +0200 Subject: [PATCH] Added feature specification to the README --- README.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 9b66cd8..fdb7098 100644 --- a/README.md +++ b/README.md @@ -34,6 +34,18 @@ Supported Configurations Getting Started --------------- +The `examples` folder contains several example programs. To compile them, one must specify the target device as cargo feature: +``` +$ cargo build --features=stm32f030xc +``` + +To use stm32f0xx-hal as a dependency in a standalone project the target device feature must be specified in the `Cargo.toml` file: +``` +[dependencies] +cortex-m = "0.6.0" +cortex-m-rt = "0.6.8" +stm32f0xx-hal = {version = "0.14.1", features = ["stm32f030xc"]} +``` If you are unfamiliar with embedded development using Rust, there are a number of fantastic resources available to help. @@ -42,7 +54,6 @@ If you are unfamiliar with embedded development using Rust, there are a number o - [Rust Embedded FAQ](https://docs.rust-embedded.org/faq.html) - [rust-embedded/awesome-embedded-rust](https://github.com/rust-embedded/awesome-embedded-rust) - Changelog ---------