diff --git a/docs/03-tutorial-hello-world.rst b/docs/03-tutorial-hello-world.rst index 71f1285..6329915 100644 --- 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 + not specified + +The FileCheck program expects the following grammar: + +.. code-block:: text + + filecheck [] + +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 new file mode 100644 index 0000000..9d1d2a4 --- /dev/null +++ b/examples/hello-world.check @@ -0,0 +1,2 @@ +; CHECK: Hello world +