meet your hardware, additional explanation

Open
#141 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
35/100
Issue type
Documentation
Clarity
Needs clarification
Activity status
Stale
Tech stack
rust

Research direction

Start by locating the STM32F3DISCOVERY hardware documentation and the section introducing user I/O. Explain the buttons, pin headers, SWD, and relevant microcontroller capabilities such as the onboard ADC, with examples that help newcomers understand later peripheral code; done when the board's hardware is clearly introduced for readers with different levels of background.

Written by the indexing model from the issue text.

Description

people new to hardware love user I/O. First question: what do the buttons do?

Also interesting would be to say something about the pinheaders and SWD.
Also would be interesting to say something about the capabilities of the microcontroller such as ADC converter onboard. Connect your own thermometer or something.

Either the reader knows nothing and ADC would be interesting as well.
Or the reader read the main features of the STM32F3DISCOVERY board which already mention accelerometer but not ADC.
Or the reader already knows both.
Knowing about ADC but not accelerometer is very unlikely.

But things like ADC and other on-chip components is good to mention, not just for their applications but also to use later as introduction to code. Because talking to peripherals is more complicated.

Dominant language
No language data
Stars
1.3k
Forks
223
PR merge metrics
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from rust-embedded/book

All issues in rust-embedded/book

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.