diff --git a/Cargo.toml b/Cargo.toml index 6aa56deee6857e6141b59a458db36c3c0d4d8fe3..e6ba76638d86e3c52518a1948affd9592fc34b14 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -17,3 +17,6 @@ stm32f30x = "0.6.0" [dependencies.cast] default-features = false version = "0.2.2" + +[features] +rt = ["stm32f30x/rt"] \ No newline at end of file diff --git a/Xargo.toml b/Xargo.toml new file mode 100644 index 0000000000000000000000000000000000000000..89ad4cdcaeb6cce198c64fb0e03f570429243b42 --- /dev/null +++ b/Xargo.toml @@ -0,0 +1,6 @@ +[dependencies.core] +stage = 0 + +[dependencies.compiler_builtins] +features = ["mem"] +stage = 1 \ No newline at end of file diff --git a/ci/script.sh b/ci/script.sh index cec34cedf1b2fa653193ae1aee2a6cc1037e08a5..9b6899a8bf43080888615d522897571c6b33ff63 100644 --- a/ci/script.sh +++ b/ci/script.sh @@ -9,6 +9,7 @@ main() { ;; *) xargo check --target $TARGET + xargo check --target $TARGET --features rt ;; esac diff --git a/src/lib.rs b/src/lib.rs index 4a809c6c501f331f1b8e31ad4bc7ea200a9e04b8..bb78f621ca867df31ad409a1925d4fff0422d0df 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -5,11 +5,19 @@ //! //! [`embedded-hal`]: https://github.com/japaric/embedded-hal //! +//! # Usage +//! +//! To build applications (binary crates) using this crate follow the [cortex-m-quickstart] +//! instructions and add this crate as a dependency in step number 5 and make sure you enable the +//! "rt" Cargo feature of this crate. +//! +//! [cortex-m-quickstart]: https://docs.rs/cortex-m-quickstart/~0.2.3 +//! //! # Examples //! //! Examples of *using* these abstractions can be found in the documentation of the [`f3`] crate. //! -//! [`f3`]: https://docs.rs/f3/0.5.0/f3/ +//! [`f3`]: https://docs.rs/f3/~0.5.1 #![deny(missing_docs)] #![deny(warnings)]