search

ryukinix / mal

MAL: A MyAnimeList Command Line Interface [BROKEN: BLAME MyAnimeList]
https://mal.readthedocs.io
Other
109 stars 9 forks source link

Update the README.md about new dependencies, grammar and usage gifs #8

Closed ryukinix closed 8 years ago

ryukinix commented 8 years ago

Probably the english in the document is bad (i don't know, but in general my english is pretty bad).

We need a more clear apresentation too. Removing some gifs?

alexkubica commented 8 years ago

How did you generate the gifs? If you'll approve https://github.com/ryukinix/mal/pull/12 they should be updated too. Edit: We can use asciinema.

ryukinix commented 8 years ago

Yes, we can use asciinema. But i prefer gifs because is embedded and playable directly on github page. I used ttygif written in C, but seems deprecated and a block the son of a bitch whose wrote that shit (horrible implementation, crash my system a lot of times and he shut up my mouth when i created a issue about that). BTW, we need another alternative at which seems be good: https://github.com/sugyan/ttygif

alexkubica commented 8 years ago

Is pypandoc still relevant for the dependencies?

alexkubica commented 8 years ago

Updated readme on my fork: https://github.com/AlexK-IL/mal/tree/update_readme A few things are left:

ryukinix commented 8 years ago
  1. Pypandoc is only usefull for upload to pypi, to translate markdown to postscript. I think we can omit this on README.md because for users they don't need care about this.
ryukinix commented 8 years ago

Thanks for doing that.

ryukinix commented 8 years ago

Can you point in README about installation of mal on ArchLinux? This would be great.

alexkubica commented 8 years ago

I removed pypandoc: https://github.com/AlexK-IL/mal/commit/2b4cc97f21d949edae61f52d32574ac92e7763e3 And added an installation guide for archlinux: https://github.com/AlexK-IL/mal/commit/f04f612aa31ce86ae3afe489367c9e94aef0ca85 Could you record a gif? My terminal is messed until the next version of decorating.

ryukinix commented 8 years ago

Main Usage

tty-main

Listing special lists

tty-list

All another gifs for now is unecessary. Just that two is enough.

alexkubica commented 8 years ago

Thanks a lot! I'll add these gifs.

ryukinix commented 8 years ago

I update the http://manoel.tk/MAL usage too.

alexkubica commented 8 years ago

I think I'm done: https://github.com/AlexK-IL/mal/tree/update_readme I added the gifs and also updated decorating version. I'll create a PR soon.

alexkubica commented 8 years ago

I guess we can close it :)