From 44bc77a8a70b266067208033fc390f953ca42c62 Mon Sep 17 00:00:00 2001 From: Alex Palaistras Date: Wed, 28 Dec 2016 22:25:07 +0000 Subject: [PATCH] README.md: Add "Status & Examples" section --- README.md | 67 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 67 insertions(+) diff --git a/README.md b/README.md index 79cd192..780aeae 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,73 @@ A `Makefile` is provided for running tests and producing documentation for Grawk 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-LineGenerated 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.