summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJames Ennis <james.ennis@codethink.com>2018-04-17 18:04:51 +0100
committerJames Ennis <james.ennis@codethink.com>2018-04-17 18:14:16 +0100
commit49673bfd5edf650b472cec33fd633997f1de2084 (patch)
treee27af64341014b046ad1c91b37c7a8410c9429d0
parente01f7869dfb2579eaf775c2be87d83bd17dc40a6 (diff)
downloadbuildstream-getting-started-section.tar.gz
examples.rst: New file for examples and How To'sgetting-started-section
-rw-r--r--doc/source/examples.rst31
-rw-r--r--doc/source/main_using.rst1
2 files changed, 32 insertions, 0 deletions
diff --git a/doc/source/examples.rst b/doc/source/examples.rst
new file mode 100644
index 000000000..62cde4049
--- /dev/null
+++ b/doc/source/examples.rst
@@ -0,0 +1,31 @@
+
+
+.. _examples:
+
+Examples and How To's
+=====================
+
+
+Running basic BuildStream commands
+----------------------------------
+
+
+``bst build``
+~~~~~~~~~~~~~
+
+
+``bst track``
+~~~~~~~~~~~~~
+Just need to understand the usefulness of this.
+
+
+Opening a new workspace
+~~~~~~~~~~~~~~~~~~~~~~~
+
+
+``bst shell``
+~~~~~~~~~~~~~
+
+
+``bst checkout``
+~~~~~~~~~~~~~~~~
diff --git a/doc/source/main_using.rst b/doc/source/main_using.rst
index 68812d3f3..a69da18ca 100644
--- a/doc/source/main_using.rst
+++ b/doc/source/main_using.rst
@@ -11,5 +11,6 @@ This section details how to use the BuildStream command line interface and work
:maxdepth: 2
getting_started
+ examples
commands
user_config