README: Add license badge, link to Orthogonal Git post

This commit is contained in:
Alex Palaistras 2017-01-12 23:06:23 +00:00
parent 7d46f0f493
commit 8516e8e139
1 changed files with 4 additions and 1 deletions

View File

@ -1,7 +1,9 @@
# Grawkit - The Awksome Git Graph Generator # Grawkit - The Awksome Git Graph Generator [![MIT License][license-svg]][license-url]
Grawkit is a tool that helps build SVG graphs from git command-line descriptions, and is built in Awk. Grawkit is a tool that helps build SVG graphs from git command-line descriptions, and is built in Awk.
This tool was created in support of the ["Orthogonal Git Workflow"][orthogonal-git] post. Yes, this took way longer to write than the post itself.
## Testing & Documentation ## Testing & Documentation
A `Makefile` is provided for running tests and producing documentation for Grawkit. Run `make help` in the project root for more information. A `Makefile` is provided for running tests and producing documentation for Grawkit. Run `make help` in the project root for more information.
@ -110,5 +112,6 @@ git merge feature/ZZ-704_take-it-to-the-limit</code></pre></th>
All code in this repository is covered by the terms of the MIT License, the full text of which can be found in the LICENSE file. All code in this repository is covered by the terms of the MIT License, the full text of which can be found in the LICENSE file.
[orthogonal-git]: https://deuill.org/post/orthogonal-git-workflow/
[license-url]: https://github.com/deuill/grawkit/blob/master/LICENSE [license-url]: https://github.com/deuill/grawkit/blob/master/LICENSE
[license-svg]: https://img.shields.io/badge/license-MIT-blue.svg [license-svg]: https://img.shields.io/badge/license-MIT-blue.svg