You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This sub-issue will deliver the core project documentation, specifically focusing on the setup and installation guides for our development environment. This includes detailing the commands and package installation process for our Yocto Project OS, as well as the step-by-step procedures for flashing compiled code onto the STM32 microcontroller.
2 - Tasks
Draft the main README.md containing a high-level project overview, hardware/software requirements, and an index linking to the detailed guides.
Write a step-by-step installation guide for setting up the Yocto Project environment (host dependencies, build commands, and custom package installation).
Document the STM32 flashing procedure, including required hardware tools (ST-LINK, etc.), driver installation, and terminal commands/utilities (e.g., openocd, STM32CubeProgrammer).
Verify and test all command-line snippets on a clean machine to ensure accuracy.
Review markdown formatting to ensure clear visual separation of commands and expected outputs.
3 - Acceptance Criteria
The main README.md clearly points developers to the Yocto and STM32 setup documentation.
The Yocto setup guide lists all required host packages and build steps needed to successfully compile the OS image.
The STM32 guide provides clear, copy-pasteable commands to flash the target hardware successfully.
All code blocks and shell commands are technically accurate, formatted correctly, and tested.
4 - Notes / Implementation details
Target Hardware: STM32 board (specify model if necessary) and the target platform running our Yocto build.
Flashing commands (e.g., openocd -f ... or st-flash write ...).
Formatting Tip: Use descriptive bash blocks with comments to explain flags (e.g., why a specific memory address or configuration file is used during flashing).
1 - Short description
This sub-issue will deliver the core project documentation, specifically focusing on the setup and installation guides for our development environment. This includes detailing the commands and package installation process for our Yocto Project OS, as well as the step-by-step procedures for flashing compiled code onto the STM32 microcontroller.
2 - Tasks
README.mdcontaining a high-level project overview, hardware/software requirements, and an index linking to the detailed guides.openocd,STM32CubeProgrammer).3 - Acceptance Criteria
README.mdclearly points developers to the Yocto and STM32 setup documentation.4 - Notes / Implementation details
bitbake <image-name>,oe-init-build-env).openocd -f ...orst-flash write ...).