Suggestion: improve the README and show how the tool works in practice
See original GitHub issueI’ve read the README and it’s very unclear how this library actually works – what goes in, what comes out, that sort of thing. Perhaps a link to a howitworks.md
in the README.
Issue Analytics
- State:
- Created 4 years ago
- Reactions:9
- Comments:5
Top Results From Across the Web
README Best Practices - Tilburg Science Hub
Learn how to write a convincing and effective README file. Get to know the best practices with our examples and templates for GitHub...
Read more >Essential Sections for Better Documentation of a README ...
README files are my entry points to “feeling out” new ...
Read more >How to write a good README for your GitHub project?
Today we will focus on good practices of writing such a file - with a few examples, and a ready to use template....
Read more >Intro to ReadMe - ReadMe Documentation
All of your documentation is written with our Markdown Editor. Learn more about how our Editor works here. If you're ready to jump...
Read more >fatal: pathspec 'README.txt' did not match any files
You need to use another tool to do so. Use your favorite text editor (I suggest Notepad++, Sublime Text 3, or Atom) and...
Read more >Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start FreeTop Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
Top GitHub Comments
totally agree here. There really needs to be even a VERY simple example.
I didn’t use it.
On Mon, Apr 27, 2020 at 9:30 AM Indraraj notifications@github.com wrote: