lua-filters icon indicating copy to clipboard operation
lua-filters copied to clipboard

Add descriptions of each filter to the main README.md

Open the-solipsist opened this issue 5 years ago • 4 comments

This pull request helps address the problem of not knowing what's in each filter's folder in case the filter title isn't descriptive enough.

the-solipsist avatar Oct 19 '20 13:10 the-solipsist

This would require manual modification of the main README.md any time a filter is added.

We could adopt the convention that the first paragraph of a filter's README.md should be a short general description (this is true already in most if not all cases), and then create a Makefile target that updates the main README.md from these.

(Also, it would be good to keep line lengths to < 80 characters, as is the case throughout most of this repository.)

jgm avatar Oct 19 '20 16:10 jgm

Of course, another option would be to document modifying the main README.md as part of the filter submission process.

jgm avatar Oct 19 '20 16:10 jgm

I feel adding to the main README.md as part of the filter submission process would be the way to go. I feel having an overview of all the filters on a single page is very useful.

the-solipsist avatar Dec 02 '20 21:12 the-solipsist

I remember first finding and exploring this repository and wishing it had an overview index like this. The upkeep is a little bit of work, but I think making the filters more approachable is probably worth it.

alerque avatar Dec 12 '20 08:12 alerque