summaryrefslogtreecommitdiff
path: root/doc/examples
diff options
context:
space:
mode:
authorTristan Van Berkom <tristan.vanberkom@codethink.co.uk>2018-06-16 13:20:40 -0400
committerTristan Van Berkom <tristan.vanberkom@codethink.co.uk>2018-06-16 16:14:04 -0400
commit1b88e2c6f0e3b060d7319e69d9ddf45bed98596f (patch)
treed704d114d1e543914dfd68e48421ece7eda16982 /doc/examples
parentb592a80b0e4e244ce50b2452ffcd655fd843bf81 (diff)
downloadbuildstream-1b88e2c6f0e3b060d7319e69d9ddf45bed98596f.tar.gz
doc: Adding part 1 of the getting started tutorial
o doc/Makefile: Added new directory to collect rst files from o doc/examples/first-project: Added the "first-project" example project. o doc/source/sessions/first-project-*.html: Added the generated snippets o doc/source/using_tutorial.rst: Added the new main tutorial page o doc/source/tutorial/first-project.rst: Added part 1 of the tutorial here o tests/examples/first-project.py: Added test for the example project This is largely based on an example by Javier Jardón, which was submitted at https://gitlab.com/BuildStream/buildstream/merge_requests/323 Fixes #103
Diffstat (limited to 'doc/examples')
-rw-r--r--doc/examples/first-project/elements/hello.bst13
-rw-r--r--doc/examples/first-project/hello.world0
-rw-r--r--doc/examples/first-project/project.conf8
3 files changed, 21 insertions, 0 deletions
diff --git a/doc/examples/first-project/elements/hello.bst b/doc/examples/first-project/elements/hello.bst
new file mode 100644
index 000000000..d23ebc7b6
--- /dev/null
+++ b/doc/examples/first-project/elements/hello.bst
@@ -0,0 +1,13 @@
+kind: import
+
+# Use a local source to stage our file
+sources:
+- kind: local
+ path: hello.world
+
+# Configure the import element
+config:
+
+ # Place the content staged by sources at the
+ # root of the output artifact
+ target: /
diff --git a/doc/examples/first-project/hello.world b/doc/examples/first-project/hello.world
new file mode 100644
index 000000000..e69de29bb
--- /dev/null
+++ b/doc/examples/first-project/hello.world
diff --git a/doc/examples/first-project/project.conf b/doc/examples/first-project/project.conf
new file mode 100644
index 000000000..2182d35a1
--- /dev/null
+++ b/doc/examples/first-project/project.conf
@@ -0,0 +1,8 @@
+# Unique project name
+name: first-project
+
+# Required BuildStream format version
+format-version: 9
+
+# Subdirectory where elements are stored
+element-path: elements