I’ve been reorganizing some of my Github repos these days and I realized that some repos, not only mine, are difficult to visualize. You can spend some good time creating a detailed README.md file, and add some screenshots, but some times that’s not enough to illustrate what the code does.
I found this very useful service called Online-Convert.com, and one of its features is to take a movie file (avi,mov,mp4,m4v) and convert it into a GIF file.
This is how I do it on the Mac:
- Record the screen using QuickTime.
- Then edit your video on iMovie.
- When you’re happy with the results, export the movie. The resulting file will be an m4v video file.
Now use that video file on the Online-Convert website and it’ll be converted into a GIF file; check it out:
Then simply add it to your README using an <IMG tag. See the results here.
If the code in your repo is for something visual, I strongly recommend you use this method. It’ll help your fellow hackers to know if your repo is what they need before going through the trouble of forking/cloning and running the code.