code-problems icon indicating copy to clipboard operation
code-problems copied to clipboard

Provide overview in README

Open simevidas opened this issue 12 years ago • 2 comments

(In respone to this)

Yes, by topic would be OK. Topics like: math related, working with strings, working with arrays, etc.

The lists don't have to provide links to the sub dirs of the repo. Their purpose is just to provide a general overview of what's inside the repo. Without such an overview, the visitor has to go through the list of sub dirs one-by-one which is not very effective.

So, I think an overview in the README file would make this repo significantly more user friendly.

simevidas avatar Jun 18 '13 15:06 simevidas

Been trying to think about this, not sure what the best way is. Was thinking maybe main headings for the sort of problems and also adding tags since they can belong to multiple problem types. If you have some overview of something that you would be looking for, that would be super handy!

Thanks

blakeembrey avatar Jun 24 '13 13:06 blakeembrey

My thinking is that any overview is better than no overview. So, if you'd add just one section with a small list describing a bunch of the most useful items in this repo, that would be a good start (and better than nothing). So, a small, informal, incomplete overview would be fine.

simevidas avatar Jun 24 '13 14:06 simevidas