Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve the demo at xplr.dev #389

Closed
sayanarijit opened this issue Oct 30, 2021 · 17 comments · Fixed by #414
Closed

Improve the demo at xplr.dev #389

sayanarijit opened this issue Oct 30, 2021 · 17 comments · Fixed by #414
Labels
good first issue Good for newcomers help wanted Extra attention is needed

Comments

@sayanarijit
Copy link
Owner

The GIF demo hosted on https://xplr.dev is a bit outdated and quite large, slowing the website down.

Let's create a demo video and display that instead.

We can keep the video here which will get uploaded to the website.

Bonus: Showoff some video editing skills.

@sayanarijit sayanarijit added good first issue Good for newcomers help wanted Extra attention is needed labels Oct 30, 2021
@sayanarijit sayanarijit changed the title Improve the demo in xplr.dev Improve the demo at xplr.dev Oct 30, 2021
@sayanarijit sayanarijit pinned this issue Oct 30, 2021
@igorepst
Copy link
Contributor

You may use SimpleScreenRecorder to record video in MP4 format, making selection of the xplr's terminal window or a rectangular region of a screen. IDK how to host the video on your site specifically, but apparently GitHub makes it possible to add video to Markdown files directly from it's builtin editor by pressing on 'Attach files by dragging...' at the bottom. See https://github.com/igorepst/context-switch.xplr/blob/main/README.md.
IMHO, it would be preferable not to add it to assets so it won't be downloaded during cloning (GH uploads it to user-images.githubusercontent.com) + using light background instead of dark.
If you wish I may record something tomorrow or on Friday

@sayanarijit
Copy link
Owner Author

@igorepst thanks for you input. I wanted to add the video in assets because it'd let me upload the video to cloudflare pages from where it'd be served. But I agree it'll bloat the size of the repo. I guess we can first record the demo and then decide whether keeping it in the repo would be a good idea, based on the size. If not, we need to use other hosting services as I don't think github readme is a good place to host video for another website.

If you wish I may record something tomorrow or on Friday

Sure, go ahead. Not required, but see if you can highlight customisability using different themes and layouts. Might need some editing skills.

@igorepst
Copy link
Contributor

I wrote a 'scenario'. Will record in the evening

@igorepst
Copy link
Contributor

53 sec - 10 Mb - h264 1912x1036 30.000fps, incl. textual info
https://user-images.githubusercontent.com/1630792/141659603-7e486564-bb6f-4cd6-92ed-d9642b753112.mp4

Dark background part - 17 sec - 650 Kb - h264 1912x1036 30.056fps, without text

dark.mp4

Light background part - 35 sec - 1.3Mb - h264 1912x1036 30.028fps, without text

light.mp4

@sayanarijit
Copy link
Owner Author

Awesome...thanks 👍

@sayanarijit
Copy link
Owner Author

I'll try to find some opensource music that matches with the demo.

@sayanarijit
Copy link
Owner Author

Btw is there really a plugin implementing split?

@igorepst
Copy link
Contributor

Depending on the terminal, yes, my term.xplr

@sayanarijit
Copy link
Owner Author

Ah ok that one...

@sayanarijit
Copy link
Owner Author

sayanarijit commented Nov 14, 2021

How about mixing with this music https://freemusicarchive.org/music/Monkey_Warhol/boots-pants-ep/boots-pants-sidekick-wave-instrumental-remix ?

Feels very energetic and the pace also somewhat matches the demo.

@igorepst
Copy link
Contributor

Nice music you found. If you want me to learn to add this track to the full video, please tell me from which second of the music to start. Otherwise, if you do it yourself, go for it.
BTW, beforehand, we may change text/cut out scenes/add something else to the video. After all, the decision and the approval should be yours

@sayanarijit
Copy link
Owner Author

Thanks, I have some (noob) experience with video editing, so I can do it once I get some time, but if you feel like learning, you can also do so. I don't really have any intention of nitpicking since this isn't vital to the core logic. The goal is to have fun, as long as the users aren't affected.

@sayanarijit
Copy link
Owner Author

sayanarijit commented Nov 14, 2021

As for from which second of the music to start., I guess from the start should be fine.

Edit: but not "have to be", anything that sounds cool.

@igorepst
Copy link
Contributor

@sayanarijit The link to the video file with the audio is here. The file is 11 Mb and is too big for GitHub. Please tell me when you download it so I may delete the file and this comment. Tnx

@sayanarijit
Copy link
Owner Author

@sayanarijit The link to the video file with the audio is here. The file is 11 Mb and is too big for GitHub. Please tell me when you download it so I may delete the file and this comment. Tnx

Cool. Done 👍

sayanarijit added a commit that referenced this issue Nov 15, 2021
Video contributed by @igorepst

Closes: #389
sayanarijit added a commit that referenced this issue Nov 15, 2021
Video contributed by @igorepst

Closes: #389
@igorepst
Copy link
Contributor

Hi. I was happy to contribute :)
It seems you have to attribute the music artist according to the license (https://creativecommons.org/licenses/by/4.0/), although I am not 100% sure, as xplr is in public domain. FYI

@sayanarijit
Copy link
Owner Author

Right, thanks, I have to attribute even if it's in public domain. At first, I added a link to the music, but now added full details just to be safe.

@sayanarijit sayanarijit unpinned this issue Dec 12, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants