diff options
| author | Fuwn <[email protected]> | 2022-02-20 22:12:53 -0800 |
|---|---|---|
| committer | Fuwn <[email protected]> | 2025-06-09 00:46:09 -0700 |
| commit | 6a60ab88ea51514d107f280671ad0526c28f17a0 (patch) | |
| tree | 038210cd65bad8a7aee81177c2772cdece8cf4f1 | |
| parent | fix(divina): human_panic Metadata into() (diff) | |
| download | archived-divina-6a60ab88ea51514d107f280671ad0526c28f17a0.tar.xz archived-divina-6a60ab88ea51514d107f280671ad0526c28f17a0.zip | |
doc(examples): readme
| -rw-r--r-- | examples/README.rst | 31 |
1 files changed, 31 insertions, 0 deletions
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. |