Skip to content

Commit

Permalink
docs: add a WIP setup doc
Browse files Browse the repository at this point in the history
Signed-off-by: HaoboGu <[email protected]>
  • Loading branch information
HaoboGu committed Feb 6, 2024
1 parent cf85370 commit 3c19c31
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions docs/src/setup_rust_environment.md
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit 3c19c31

Please sign in to comment.