hoaproject/Console

Update autocompleters documentation

Hywan opened this issue · 11 comments

What do you think of this kind of README: https://github.com/Hywan/Console/tree/documentation-test#readline (scroll to the gif)?

That's very cool but it's another thing to keep updated when we update the lib and it's not as easy as a MD file to update ? I would rather use this in promotional content (blog post...) than in documentation.

But since the READMEs represent the “homepages” of the library, maybe one or two Gif are not a big deal. Thoughts?

My main concern is about maintainability, If you think we can maintain these Gif without problem, let's go because it's really cool to provide a quick insight of what the library does.

I am using the ToGif command from the awecode repository. I am currently optimizing the output file size while having a better quality (you can see white dots in the current version).

Can you show me a sample of the input file for the Console gif ?

(new ToGif command, here is the result: Hywan@0d51593?diff-0=0-100, I like Github diff also :-p)

@osaris: What do you mean?

@hoaproject nevermind, I thought about something else. This looks pretty cool too ? https://github.com/icholy/ttygif

@osaris: Nice idea. Could you test to compare the differences (in quality)? The optimizations on GIF I have made in ToGif can be reported on the output of ttygif.

Done.