todoman icon indicating copy to clipboard operation
todoman copied to clipboard

Demo animations in README

Open untitaker opened this issue 7 years ago • 16 comments

It would be nice to have a picture or even smaller audio-less demos in the README. Latter could be recorded with http://asciinema.org/

untitaker avatar Feb 02 '17 15:02 untitaker

+1 It makes a big difference, see, for example, pipenv.

WhyNotHugo avatar Feb 02 '17 15:02 WhyNotHugo

So here's on I made today quickly:

Honestly, I'll completely open to criticism and a new script for it, etc. I'm not very creative with making up actions.

WhyNotHugo avatar Feb 12 '17 13:02 WhyNotHugo

A few things:

  • --due (particularly its human datetime parsing) should be shown off
  • A typo in your task description: "by" instead of "be".

otherwise LGTM

On Sun, Feb 12, 2017 at 05:02:55AM -0800, Hugo Osvaldo Barrera wrote:

So here's on I made today quickly:

https://asciinema.org/a/c4oy6bm9axb8qyonparjmh1w2

Honestly, I'll completely open to criticism and a new script for it, etc. I'm not very creative with making up actions.

-- You are receiving this because you authored the thread. Reply to this email directly or view it on GitHub: https://github.com/pimutils/todoman/issues/81#issuecomment-279217209

untitaker avatar Feb 12 '17 13:02 untitaker

https://asciinema.org/a/5gc9baoqtx6wkgi1ytv90ncrs and https://asciinema.org/a/db3xuhufirhq0g4b22jwmmjeg

untitaker avatar Feb 12 '17 13:02 untitaker

Uh oh, the latter actually revealed a bug in todoman. -dtomorrow counts from UTC time

untitaker avatar Feb 12 '17 13:02 untitaker

Yeah, I also uncovered another bug (when not passing any summary) when doing this demo.

We need to figure out how to test the urwid bit.

WhyNotHugo avatar Feb 12 '17 13:02 WhyNotHugo

Turns out the default due date got set after setting the user-defined due date 💩 Fixed in master

untitaker avatar Feb 12 '17 14:02 untitaker

Here's another screencast: https://asciinema.org/a/7ifwbqub2f9e3ntgzk0iszf8g

untitaker avatar Feb 12 '17 15:02 untitaker

Back on-topic:

  • asciinema records your terminal size, so something more convervative (25*80) looks better. Especially if it goes into the README. I use i3wm, and just make the terminal window float for it to take its default size.
  • I like showing off the config and find, but I'd move that to the end, and start off showing the app itself first.
  • I mostly liked this one: https://asciinema.org/a/5gc9baoqtx6wkgi1ytv90ncrs
  • I'd prefer "real-looking" todos. Rather than "hello world", make up something that sounds like an actual task.

Also of importance: I don't see how to download a video/gif from asciinema.

WhyNotHugo avatar Feb 13 '17 13:02 WhyNotHugo

I think we can edit the JSON recording just for resizing the terminal, but I'm not sure.

I suppose we have to record this in some other way because of the GIF though. A real video with sound would be nice

untitaker avatar Feb 13 '17 13:02 untitaker

Sound?

WhyNotHugo avatar Feb 13 '17 13:02 WhyNotHugo

Something like the video at http://beets.io/

untitaker avatar Feb 13 '17 13:02 untitaker

The voiceover is actually quite helpful, and showing the config makes for sense with it.

WhyNotHugo avatar Feb 13 '17 17:02 WhyNotHugo

ttyrec and ttygif produce really good results. :+1:

WhyNotHugo avatar Feb 16 '17 23:02 WhyNotHugo

Script idea:

  • Start of with two tasks, with and without due dates, and lists with colors.
  • todo new SOMETHING
  • todo new -l work SOMETHING
  • todo
  • todo edit 3, edit due date
  • todo
  • todo done 2
  • cat config
  • tree paths
  • cat ics file

More details:

  • Make sure we use the latest version of todoman (unlike my previous recording).
  • 80x25 terminal.
  • Tasks are better if they sound real ("purchase ticket", "organize party", etc).
  • I prefer date_format = %Y-%m-%d %H:%M for the demo.

WhyNotHugo avatar Feb 17 '17 01:02 WhyNotHugo

Maybe this issue is without progress for 7 years because the bar is too high. Maybe it doesn't need a well-scripted movie. Even a few screenshots may help for a start. Just my two cents.

hartwork avatar Mar 30 '24 13:03 hartwork