Create codefmt usage screencast for README.md

google / vim-codefmt

Vim plugin for syntax-aware code formatting

Apache License 2.0

1.11k stars 114 forks source link

Create codefmt usage screencast for README.md #25

Open dbarnett opened 9 years ago

dbarnett commented 9 years ago

Lots of vim plugins have fancy screencasts (animated GIFs) in the README.md showcasing plugin features. The codefmt plugin has several useful features that would make a nice screencast.

We should create a screencast and embed it in our README.md. If we could also include a keyboard monitor in the screencast, that would help show off all the handy mappings.

rnmhdn commented 6 years ago

Actually I can't even find what the mappings are! I could find it from :h FormatCode yet I think it would have been better if you have listed some of the useful mappings in the readme.md

dbarnett commented 6 years ago

They're mentioned in the helpfile (specifically :help codefmt-mappings). Any clarifications you're looking for there?

rnmhdn commented 6 years ago

No. I just thought it would have been better if you put a few of them in the readme.md here.