From 6a60ab88ea51514d107f280671ad0526c28f17a0 Mon Sep 17 00:00:00 2001 From: Fuwn Date: Sun, 20 Feb 2022 22:12:53 -0800 Subject: doc(examples): readme --- examples/README.rst | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) create mode 100644 examples/README.rst diff --git a/examples/README.rst b/examples/README.rst new file mode 100644 index 0000000..0aa3baa --- /dev/null +++ b/examples/README.rst @@ -0,0 +1,31 @@ +Examples +======== + +Build +----- + +Build All Examples +^^^^^^^^^^^^^^^^^^ + +To build all of the available examples, execute: + +.. code-block:: shell + + $ divina build + +The resulting objects and binaries will be placed into the :code:`out/` directory. + +Build a Single Example +^^^^^^^^^^^^^^^^^^^^^^ + +To build a single example: + +1. :code:`cd` into an example directory: + + .. code-block:: shell + + cd examples/greet/ + +2. :code:`$ divina build` + +The resulting object(s) and binary will be placed into the :code:`out/` directory. -- cgit v1.2.3