implement more examples - make examples/readme.md in the directory and link from primary readme

Open Beginner friendly
#2 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
68/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Quiet
Tech stack
cpp
Domain
documentation

Research direction

Start by reviewing the existing examples directory and the primary README, then compare the repository's current examples with the best-practice reference mentioned in the issue. Add examples/readme.md with the relevant examples and link it from the primary README; done means the new page exists and is reachable from the main README.

Written by the indexing model from the issue text.

Description

See what was done here -- I consider this best practice for libraries now.

Dominant language
C++
Stars
3
Forks
1
PR merge metrics
No merged PRs in 30d

Contributor guide

Open the contributing guide

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 bemanproject/cycle

All issues in bemanproject/cycle

Similar issues

More C++ issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.