Skip to content

Commit

Permalink
scripts: refactor: descript usage in main readme.
Browse files Browse the repository at this point in the history
link script readme to top readme

Signed-off-by: YuLong Yao <[email protected]>
  • Loading branch information
feilongfl committed Jul 3, 2022
1 parent 8cf640a commit e48d73a
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,8 @@ The conflicts at gd32 standard peripheral API are listed by the afected file(s).
In general, a name is the conflict itself and that whould be reworked following
the gd32 standard peripheral API rules.

You can also check the refact tool at [scripts/lib_refactor](scripts/lib_refactor/)

- `<firmware_library>_timer.h/c`: `timer_init()` should be prefixed with
`gd32_` and become `gd32_timer_init()`.
- `<firmware_library>_can.h/c`: all `CAN_` macros that collide with any
Expand Down

0 comments on commit e48d73a

Please sign in to comment.