This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
#!/usr/bin/env ruby | |
=begin | |
A hook to make sure that the README is updated with the current project's structure. | |
The scripts appends at the end of your project's README a markdown representation of | |
your project. Now you have no excuses not to document your wonderful work! | |
Inspired by Readme Driven Development by Tom Preston-Werner (https://tom.preston-werner.com/2010/08/23/readme-driven-development.html) | |
Place it under .git/hooks and make sure that it is executable (chmod +x pre-commit). |