Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Examples descriptions / Readme #2

Open
Lucaffo opened this issue Jul 19, 2021 · 2 comments
Open

Examples descriptions / Readme #2

Lucaffo opened this issue Jul 19, 2021 · 2 comments

Comments

@Lucaffo
Copy link

Lucaffo commented Jul 19, 2021

It would be cool if we can have a short description of each example!
I am a sort of entusiast of "Code that explain itself" but sometimes i need to read something before go reading the code.

Nice work anyway!

@zezba9000
Copy link
Owner

Each 'demo' code file is so small and to the point it would be hard to add much more context.
Was there one in particular that was confusing?

Adding a ReadMe file isn't a bad idea if it solves a problem.

@blawnode
Copy link

I'd argue it solves a problem - Many people browse GitHub repositories for resources without the intention of using them.
The README certainly gives a better image of the project in seconds.
That especially applies to this project, as it proposes visualizations - Would be good to know what they look like.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants