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

Update README.md with a GitHub friendly video example #357

Merged
merged 1 commit into from
Jul 7, 2023

Conversation

kdheepak
Copy link
Contributor

@kdheepak kdheepak commented Jul 1, 2023

I've added a .mp4 file that shows a copy paste example of using kickstart.nvim.

@mech-a
Copy link
Contributor

mech-a commented Jul 1, 2023

Please see this comment.

@mech-a
Copy link
Contributor

mech-a commented Jul 1, 2023

I think that we want users to clone the whole repository so that they have routes to add their own custom plugins from the get-go. While I think the change in #358 is sound because it brings us in line to the readme, adding more explicit support to this installation method isn't in line with what we intend for users to do. Kickstart was intentionally expanded with multi-file support, and we want new users to be able to see that.

@kdheepak
Copy link
Contributor Author

kdheepak commented Jul 1, 2023

That makes sense. I’ll update the video to show an installation using a clone.

@kdheepak
Copy link
Contributor Author

kdheepak commented Jul 1, 2023

I've pushed another mp4 file that uses git clone instead.

@feoh
Copy link
Collaborator

feoh commented Jul 7, 2023

I'm struggling a bit evaluating this one because as a visually impaired person everything in the video is whizzing by at the speed of light.

Would love some more feedback on whether or not fully sighted folks would find this a good addition.

@mech-a , @tjdevries or anyone else?

Thanks much

@kdheepak
Copy link
Contributor Author

kdheepak commented Jul 7, 2023

I’m also open to suggestions on better ways to visually depict what kickstart.nvim does.

@feoh feoh merged commit 7a95318 into nvim-lua:master Jul 7, 2023
@feoh
Copy link
Collaborator

feoh commented Jul 7, 2023

@kdheepak Let's keep our minds open and think on that, shall we? :)

Until then, I merged your PR. Thanks for the contribution!

I realized, what harm can it do? It can only help visual learners who aren't in the cyclops minority I inhabit :)

@kdheepak kdheepak deleted the patch-1 branch July 7, 2023 18:13
@kdheepak
Copy link
Contributor Author

kdheepak commented Jul 7, 2023

Great! If anyone has ideas for improving it, feel free to post here and I’ll help in whatever way I can!

@feoh
Copy link
Collaborator

feoh commented Jul 7, 2023

I would personally like to see a slight pause between segments so I can process what's happening better, but my lacking perceptual capabilities shouldn't be a guide for your efforts :)

@mech-a
Copy link
Contributor

mech-a commented Jul 7, 2023

Thanks for the video; here are some potential improvements for round 2, in rough priority:

  • Decrease compression to limit the artifacting; it's fairly difficult to read as of now
  • Decrease viewport of video to improve readability
  • Move into installation section; the main selling point of Kickstart is not its cloneability, but readable docs :)
  • Record only the terminal window
  • Copy and paste commands instead of typing (zsh-autosuggestions are great but not something that we need to include here)
  • Use nvim and not the vim alias -- we get a lot of beginners and that would confuse them.
  • Shorten the video significantly; it'd be nice to run this on a fresh system. We can pretty easily spin up an alpine container and do it there.

@kdheepak
Copy link
Contributor Author

kdheepak commented Jul 7, 2023

Btw, we are limited to 10mb on GitHub for mp4 files. The original file without compression was 800mb.

Maybe it should be a YouTube video?

@mech-a
Copy link
Contributor

mech-a commented Jul 7, 2023

I think it's best to make it an svg/gif. MP4s at that resolution are a bit too large. See sharkdp/fd demo for a good example of an svg-based demo on a small viewport.

qiuye2015 pushed a commit to qiuye2015/fjp.nvim that referenced this pull request Dec 10, 2023
Update README.md with a GitHub friendly video example
s-frick pushed a commit to s-frick/kickstart.nvim that referenced this pull request Jul 29, 2024
Update README.md with a GitHub friendly video example
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants