1
0
mirror of https://github.com/deuill/grawkit.git synced 2024-09-28 08:22:46 +00:00
grawkit/play/static/template/default-preview.template
Alex Palaistras 24d63cd8a9 Implement initial version of Grawkit Web Playground
Running `grawkit` locally can be a hassle for one-off tasks, and can be hard to iterate against
when plotting graphs based on complex command-line descriptions. Given recent fixes for POSIX
compatibility, this commit implements a basic web-based "playground"-style application that allows
for entering command-line descriptions in an HTML textarea, and seeing the results (or errors)
instantly.

The playground application itself is built in Go (Awk itself would be insufficient for the
throughput required, but may be investigated in the future), with the excellent GoAwk library
providing parsing and execution duties, therefore making for a pure-Go implementation (other than
Grawkit itself).

Additional support for setting custom styling and an online deployment with Docker are forthcoming.
2019-08-25 16:30:34 +01:00

27 lines
1.1 KiB
Plaintext

<h2>About the Grawkit Playground</h2>
<p>
This is an online version of the <a href="https://github.com/deuill/grawkit">Grawkit</a> tool for
building SVG graphs based on command-line descriptions of <code>git</code> commands.
</p>
<p>
Simply fill in the textarea with <code>git</code> commands, as you would enter these in the
command-line, and press 'Generate' to return an SVG graph representation.
</p>
<h3>Features</h3>
<p>
This can currently parse the following (to varying degrees):
</p>
<ul>
<li><code>git branch</code> for creating named branches</li>
<li><code>git commit</code> for adding commit markers on branches</li>
<li><code>git checkout</code> for changing branch contexts</li>
<li><code>git merge</code> for generating merges between branches</li>
<li><code>git tag</code> for adding labels to specific commits</li>
</ul>
<h3>Feedback & More Information</h3>
<p>
For a full list of features, as well as for requesting new features, check the
<a href="https://github.com/deuill/grawkit">Github page</a> or feel free to
<a href="https://deuill.org/about">contact me</a>.
</p>