Skip to content

Commit

Permalink
Fix and update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Khalil Ouali committed Feb 22, 2024
1 parent 0c22bdd commit 3e6108a
Showing 1 changed file with 9 additions and 4 deletions.
13 changes: 9 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

[![Build and test](https://github.com/KhalilOuali/FreeRTOS-STM32-VSCode-Wokwi/actions/workflows/ci.yml/badge.svg)](https://github.com/KhalilOuali/FreeRTOS-STM32-VSCode-Wokwi/actions/workflows/ci.yml)

![Screenshot during debugging](Screenshot.png)

## Description

- Framework: `FreeRTOS / HAL`
Expand All @@ -18,8 +20,6 @@
- Simulation: `Wokwi`
- CI/CD: `GitHub Actions` + `Wokwi CI`

![Screenshot during debugging](Screenshot.png)

## Prerequisites

- [Arm GNU Toolchain](https://developer.arm.com/downloads/-/arm-gnu-toolchain-downloads) for compilation
Expand All @@ -30,7 +30,7 @@

1. Clone this repo
2. Open in [VSCode](https://code.visualstudio.com/)
3. Install the `[recommended extensions](.vscode/extensions.json)
3. Install the [recommended extensions](.vscode/extensions.json)
4. Run VSCode debugger on `Build & Debug` task

VSCode will automatically build the project, start the Wokwi simulator and attach the debugger.
Expand Down Expand Up @@ -103,7 +103,7 @@ See [Wokwi CI](https://docs.wokwi.com/wokwi-ci/getting-started) for more details
### STM32CubeMX

This project was initially generated using STM32CubeMX.
You can open [`Nucleo-C031C6-FreeRTOS.ioc`](Nucleo-C031C6-FreeRTOS.ioc) in STM32CubeMX to reconfigure the project.and regenerate the code.
You can open [`Nucleo-C031C6-FreeRTOS.ioc`](Nucleo-C031C6-FreeRTOS.ioc) in STM32CubeMX to reconfigure the project and regenerate the code.
The generated code has some issues. Check or run [`fix_MX_codegen.py`](fix_MX_codegen.py) for the fixes.

## Development
Expand All @@ -112,6 +112,11 @@ The main user code is in [`Core/Src/main.c`](Core/Src/main.c) and [`Core/Src/app
The FreeRTOS configuration is in [`Core/Inc/FreeRTOSConfig.h`](Core/Inc/FreeRTOSConfig.h).
It is recommended that you write your code within the `USER CODE` sections, as STM32CubeMX will overwrite the rest of the files if you use it to reconfigure the project and regenerate the code. (Hence the need for the [`fix_MX_codegen.py`](fix_MX_codegen.py) script.)

Relevant documentation:

- [NUCLEO-C031C6 Board User Manual](https://www.st.com/resource/en/user_manual/um2953-stm32-nucleo64-board-mb1717-stmicroelectronics.pdf)
- [STM32C031C6 MCU Datasheet](https://www.st.com/resource/en/datasheet/stm32c031c6.pdf)

## Acknowledgements

- Originally based on [Wokwi/stm32-hello-wokwi](https://github.com/wokwi/stm32-hello-wokwi).
Expand Down

0 comments on commit 3e6108a

Please sign in to comment.