diff --git a/docs/src/create_project.md b/docs/src/create_project.md index a4e8f4ba..5c001fbf 100644 --- a/docs/src/create_project.md +++ b/docs/src/create_project.md @@ -18,7 +18,7 @@ cargo generate --git https://github.com/HaoboGu/rmk-template This command would ask you to fill some basic info of your project, it requires a little bit deeper understanding of your chosen hardware. If you don't know what to fill, check [this section]() in overview first. The following is an example. In the example, a `stm32` microcontroller `stm32h7b0vb` is used, the corresponding target is `thumbv7em-none-eabihf`: -```bash +```shell $ cargo generate --git https://github.com/HaoboGu/rmk-template 🤷 Project Name: rmk-demo 🔧 Destination: /Users/haobogu/Projects/keyboard/rmk-demo ... @@ -39,10 +39,11 @@ A RMK firmware project will be automatically created after you fill out all requ If you're lucky enough, you could just compile your firmware using `cargo build`. But for the most of the cases, there are minor modifications you have to do. All TODOs are listed in the `README.md` file in the generated project. -The followings are the detailed guides for those TODOs: +The followings are the detailed steps: ### 2.1 Update memory.x `memory.x` is the linker script of Rust embedded project, it's used to define the memory layout of the microcontroller. For most ARM Cortex-M microcontrollers, you only need to update the `LENGTH` of FLASH and RAM to your microcontroller. You can either checkout your microcontroller's datasheet or existing Rust project of your microcontroller for it. -### 2.2 Update USB interrupt binding in `main.rs` \ No newline at end of file +### 2.2 Update USB interrupt binding in `main.rs` +