Merge pull request #36 from stanislaw/develop

docs: Tutorial: Hello World some content
mull-project · Nov 29, 2019 · 821dfb3 · 821dfb3
2 parents 9021851 + f696144
commit 821dfb3
Show file tree

Hide file tree

Showing 2 changed files with 27 additions and 1 deletion.
diff --git a/docs/03-tutorial-hello-world.rst b/docs/03-tutorial-hello-world.rst
@@ -1,6 +1,30 @@
 Tutorial: Hello World
 =====================
 
-...
+This tutorial assumes that you have installed ``filecheck`` and have it
+available in your PATH:
+
+.. code-block:: bash
+
+   $ filecheck
+   /usr/local/bin/filecheck
+   <check-file> not specified
+
+The FileCheck program expects the following grammar:
+
+.. code-block:: text
+
+   filecheck <check-file> [<options>]
+
+Create new file ``hello-world.check`` with the following contents:
+
+.. code-block:: text
+
+   ; CHECK: Hello world
+
+.. code-block:: bash
+
+   echo "Hello world" | filecheck hello-world.check
+   /usr/local/bin/FileCheck
 
 
diff --git a/examples/hello-world.check b/examples/hello-world.check
@@ -0,0 +1,2 @@
+; CHECK: Hello world
+