Skip to content

Instantly share code, notes, and snippets.

View GLodi's full-sized avatar

Giulio Lodi GLodi

View GitHub Profile
@GLodi
GLodi / pre-commit
Last active August 26, 2022 14:17
A hook to make sure that your README is updated with the current project's structure.
#!/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).