Skip to content

Commit

Permalink
Add video demo to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
@apexskier
apexskier committed Dec 20, 2020
1 parent 1a167fc commit 5a855f4
Show file tree
Hide file tree
Showing 2 changed files with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
It's a small utility for realtime filtering of text streams in your terminal
using regular expressions.

![Demo](https://content.camlittle.com/rrf-demo.mov)
![Demo](./rrf-demo.mov)

## Usage

Expand Down
Binary file added rrf-demo.mov
View file
Binary file not shown.

13 comments on commit 5a855f4

@bl-ue
Copy link

@bl-ue bl-ue commented on 5a855f4 Dec 20, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@apexskier Another solution for the demo video is to use asciinema. You can embed it, and it will have really high resolution (since it's just text.). It's pretty cool, I think.

BTW I think the app itself looks interesting. It's particularly useful when you have a large amount of slow output coming out, e.g. tail -f on a log file.

@apexskier
Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I actually was trying to use asciinema originally, but I didn't think it was possible to embed it in a readme. Do you have an example?

@bl-ue
Copy link

@bl-ue bl-ue commented on 5a855f4 Dec 20, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well maybe you can't embed the video and have it play, in the README, but you can embed an image and link it to the online recording.
asciinema/asciinema#162

<a href="https://asciinema.org/a/14?autoplay=1" target="_blank"><img src="https://asciinema.org/a/14.png" width="835"/></a>

@apexskier
Copy link
Owner Author

@apexskier apexskier commented on 5a855f4 Dec 20, 2020 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm trying to use svg-term-cli, but unfortunately I get crashes when I run it on my recording

@bl-ue
Copy link

@bl-ue bl-ue commented on 5a855f4 Dec 20, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wow that's a great tool. Definitely try it. That link is broken...

@bl-ue
Copy link

@bl-ue bl-ue commented on 5a855f4 Dec 20, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You know, I've seen usages of that before, I'm pretty sure.

@apexskier
Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ah, here's the link https://asciinema.org/a/Psv7iVedvswxtGMo4AE8F2AkH

@apexskier
Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The other issue with asciinema is that it doesn't show my highlighting correctly.

@bl-ue
Copy link

@bl-ue bl-ue commented on 5a855f4 Dec 20, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I noticed that too. svg-term allows the underline, but not the dimming.

I was able to get your recording into an svg without errors. Psv7iVedvswxtGMo4AE8F2AkH.svg.zip

@bl-ue
Copy link

@bl-ue bl-ue commented on 5a855f4 Dec 20, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I opened an issue asciinema/asciinema#425. Maybe they'll get back. I'll look into adding the support myself at some point, too.

In the meantime, as a workaround, you could just change the color, rather then dimming it. Of course who wants to change the app just for a demo but...

You could also temporarily make it output a light color, then record, then go back to dim.

@bl-ue
Copy link

@bl-ue bl-ue commented on 5a855f4 Dec 20, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I should have searched. asciinema/asciinema-player#52 has been open for almost 4 years 😱

@apexskier
Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I also looked into hosting the demo off GitHub, but ran into this - atmos/camo#164. Doesn't look like that project's maintained any more though so I also submitted a GitHub support ticket.

@bl-ue
Copy link

@bl-ue bl-ue commented on 5a855f4 Dec 20, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tomorrow I'll look at adding \e[2m support. Clojure looks insane but the attribute-specific code itself looks reasonable:
https://github.com/asciinema/vt/blob/fecc4f04c13ceb7984678cc93fa0fde2a192f042/src/asciinema/vt.cljc#L258-L270

Commit fecc4f0 makes it look really easy.

Please sign in to comment.