matiassingers/awesome-readme

Categorize examples by ecosystems

gugakatsi opened this issue · 10 comments

I think It'd be great, maybe small web-page for it with filters etc...

Robson commented

What would be an example ecosystem?

Javascript, Web, Mobile... - all have specific problems and common languages. Today I wanted to see READMEs of js libraries, how they communicate with users quickly, and where/when they mention certain stuff. Can you get a sense of what I mean?

EDIT: It could be solved by including tags in README ( like for some projects could be: [ javascript, web, node, cjs ], ) so the user can find them easily with ctrl + f ( I tried that today). But I think a small filtering web-page would make researching better in many ways.

I prefer the idea of tags to a single categorical division, since different people may have different needs in how they would group the listed entries.

Robson commented

The list of readme files has grown quite large, so a way to categorise them would be helpful. I agree that tagging is the best approach, for the same reason as @waldyrious

@Robson @waldyrious What do you think is a good solution for categorizing ? The first thing I thought was just parsing all readmes from the list, grabbing keywords from them, then sorting them automatically, and after that, we could manually edit it a bit or just make sorting automation better/good.

grabbing keywords from them

What's your idea of how to do this? Some sort of automated analysis of salient tokens, or matching the text of the READMEs to a predefined list of terms, or just reading the text and manually collecting relevant keywords?

It seems to me that it may be easier to just define a set of tags based on a high-level overview of the existing READMEs, add them to the listed READMEs as appropriate, and allow people to manually add more tags if the need arises.

@waldyrious I think matching with a predefined list of terms ( source haven't thought yet, but handlable ) and a little bit of salient token analysis, Doing it once ( and so ) could give us good results in many ways. What do you think