9elements / 9elements/picoprog

Make README include hardware instructions as well

Open
#18 1 comment 4 reactions 0 assignees View on GitHub

@MDr164 is already working on this.

Since Nov 23, 2024.

  • #23 by @MDr164 — open
Dominant language
Rust
Stars
17
Forks
7
PR merge metrics
No merged PRs in 30d

Description

We should add some pictures and instructions on how to get the hardware up and running, including the pinout.

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.

Research direction

Start by reviewing the README and the open pull request #23 to understand the work already underway. Document hardware setup with pictures and include the pinout; the README should let a reader get the hardware running without additional instructions.

Written by the indexing model from the issue text.

Assessment

Domain
documentation, embedded-iot
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.