Improved README

Open
#5 6 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

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

Research direction

Review the repository README and the example files first to understand what information is currently missing. Determine the needed guidance for running examples and whether the README should list examples with descriptions or only reference their files. Done means the README has an agreed, useful structure for both points.

Written by the indexing model from the issue text.

Description

What should be added to the README for this repo? I would suggest to add some basic information on how to run the examples. Should we also add a list of examples and a short description of each one or is the list of files enough?

Dominant language
Rust
Stars
55
Forks
9
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 embedded-graphics/examples

All issues in embedded-graphics/examples

Similar issues

More Rust issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.