deuill
/
grawkit
mirror of https://github.com/deuill/grawkit.git
1
0
Fork 0
Code Actions Packages
The Awksome Git Graph Generator
9 Commits 1 Branch 0 Tags 298 KiB
Awk 64.5%
Go 16%
Makefile 8.5%
CSS 6.8%
JavaScript 3.2%
Other 1%
Go to file
Alex Palaistras 44bc77a8a7 README.md: Add "Status & Examples" section 2016-12-28 22:25:07 +00:00
tests Fix issues with incorrect canvas sizing, label font size 2016-12-28 22:18:50 +00:00
.editorconfig First version of Grawkit, with simple single-branch test 2016-10-30 23:17:54 +00:00
LICENSE First version of Grawkit, with simple single-branch test 2016-10-30 23:17:54 +00:00
Makefile Moved tests, added color pallete for branches, fixed merges 2016-12-18 13:59:44 +00:00
README.md README.md: Add "Status & Examples" section 2016-12-28 22:25:07 +00:00
grawkit Fix issues with incorrect canvas sizing, label font size 2016-12-28 22:18:50 +00:00

README.md

Grawkit - The Awksome Git Graph Generator

Grawkit is a tool that helps build SVG graphs from git command-line descriptions, and is built in Awk.

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 full test-suite is provided (depending only on make and awk), which should serve as a good example of the existing feature-set.

Status & Examples

Grawkit has basic support for common git commands such as git branch, git tag and git merge, allowing for fairly complex graphs. The integrated test-suite serves as an example, presented here:

Command-Line Generated Graph 
git commit -m "Adding a new commit"
git commit
 Master Branch 
git commit -m "Commit on master"
git commit -m "More stuff"

git branch test-stuff
git checkout test-stuff


git commit -m 'Testing stuff'
git commit


git checkout master
git commit
 Simple Branching 

git commit -m "Commit on master"


git branch test-merging
git commit -m "Still on master"


git checkout test-merging
git commit -m 'A sample commit'


git checkout master
git commit -m "Another master commit"


git merge test-merging
 Simple Merging 
git commit -m "Commit on master"


git branch test-first
git branch test-second


git commit -m "Still on master"
git tag v.1.0.0


git checkout test-first
git commit


git checkout test-second
git commit
git merge test-first
git tag v.2.0.0-rc1


git checkout master
git merge test-second
 Merging and Tagging Multiple Branches

License

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.