As programmers, we’re almost universally guilty of it: Boring Readme.md files that nobody wants to read. Why then, shouldn’t we spice up our Readme.md files with some pizzazz? A source tree visualization is easy to add to a Readme.md using GitHub markup, and there’s an open source project which makes the visualization of the tree itself a breeze. While it never found a market as a product, Source Tree Visualizer (STV) has found a new life since being open sourced last spring. Below, I’ll show you how to add STV to your build process and display the most current version in your README.md file.
Here’s what the Readme.md for “The Grind” looks like:
While you read through the tutorial below, I’ll be working on sloooowly converting my ~90 GitHub projects’ README files over to this method as well.
And here’s a graph of a dinosaur, my favorite QuickGrapher promotional graph: