hoaproject / Console

The Hoa\Console library.
https://hoa-project.net/
366 stars 32 forks source link

Update autocompleters documentation #12

Closed Hywan closed 10 years ago

Hywan commented 10 years ago

https://github.com/hoaproject/Console/pull/11

Hywan commented 10 years ago

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

osaris commented 10 years ago

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.

Hywan commented 10 years ago

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

osaris commented 10 years ago

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.

Hywan commented 10 years ago

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).

osaris commented 10 years ago

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

Hywan commented 10 years ago

(new ToGif command, here is the result: https://github.com/Hywan/Console/commit/0d51593c681d3e24f2e5ae43f594bf26e6ffeced?diff-0=0-100, I like Github diff also :-p)

@osaris: What do you mean?

osaris commented 10 years ago

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

Hywan commented 10 years ago

@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.

Hywan commented 10 years ago

15

Hywan commented 10 years ago

Done.