Skip to content

Commit

Permalink
docs: update doc
Browse files Browse the repository at this point in the history
Signed-off-by: Haobo Gu <[email protected]>
  • Loading branch information
HaoboGu committed Feb 15, 2024
1 parent 6893d3d commit c8af98d
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions docs/src/create_project.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 ...
Expand All @@ -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`
### 2.2 Update USB interrupt binding in `main.rs`

0 comments on commit c8af98d

Please sign in to comment.