Animated documentation
breandan opened this issue · comments
The current documentation can be spruced up a bit by adding animated GIFs. When recording the GIFs, please make sure that the keystrokes are visible on screen (you can do so with a tool like keycastr or screenkey), and the editor font is clearly visible.
Animated GIFs can be embedded in the README.md just like any other image.
Interested in doing this. I'm a github noobie so let me layout the exact process of doing this in case I get something wrong ...
- fork the repo
- make some gifs
- add the gifs the README.md directly (kinda afraid of doing this)
- commit and attach the commit to this issue
- make a pull request
That's it, isn't it?
Awesome, thanks for volunteering! Basically, this is the correct process. You will need to record the GIFs somehow, then add them to be tracked on Git. You can link to GIFs in the README.md file. See here and here and here for examples. Don't be afraid of making mistakes, as the changes will only appear on your fork. You can attach this issue by mentioning #145 somewhere in your commit message. When you're ready to submit the GIFs and updated README.md file, just open a new PR using your fork ("Compare across forks", master branch is fine). Feel free to ask questions if you need help.
@uduse - it's been about 5 years, but just checking... are you still working on this? If not, I'd be up for doing it - feeling the need to write some docs :-)