From 3c19c314f19bcdbeeeaa408d09d60417ed500c46 Mon Sep 17 00:00:00 2001 From: HaoboGu Date: Wed, 7 Feb 2024 00:55:45 +0800 Subject: [PATCH] docs: add a WIP setup doc Signed-off-by: HaoboGu --- docs/src/setup_rust_environment.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) create mode 100644 docs/src/setup_rust_environment.md diff --git a/docs/src/setup_rust_environment.md b/docs/src/setup_rust_environment.md new file mode 100644 index 00000000..e1313c09 --- /dev/null +++ b/docs/src/setup_rust_environment.md @@ -0,0 +1,13 @@ +# Setup Rust environment + +## Prerequisites + +Using RMK requires basic knowledge of programming and embedded devices. We recommend you to read [The Embedded Rust Book](https://docs.rust-embedded.org/book/) first if you're not familiar with embedded Rust. + +## Install Rust + +A Rust environment is required to use RMK. Installing Rust is easy: checkout [https://rustup.rs](https://rustup.rs), follow the instructions. + +## Install your target + +TODO \ No newline at end of file