Add Some example in the "Example" Section of the README.md
Open
Nobody has claimed this yet.
documentation
enhancement
good first issue
hacktoberfest
Priority:High
- Dominant language
- C++
- Stars
- 729
- Forks
- 147
- Avg merge
- 19h
- Merged PRs (30d)
- 1
Description
Please add some good example in the Example Section.
The desired is that there is the basic example of use of the library and then subsection for each algorithm.
Please add also a good explanation for example code.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start in README.md at the Example section and review the library's existing algorithm interfaces. Add a basic library-use example, a subsection for each algorithm, and explanations for the example code; the README should clearly demonstrate usage when complete.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100