Added "Create Project" doc (still in progress)

3 files changed, 124 insertions, 1 deletions

diff --git a/doc/source/createproject.rst b/doc/source/createproject.rst
new file mode 100644
index 000000000..d68b02511
--- /dev/null
+++ b/doc/source/createproject.rst
@@ -0,0 +1,121 @@
+Creating a basic project
+====
+
+This Section assumes you have installed Buildstream already.
+
+If not, go to :ref:`install`
+
+Or :ref:`docker`
+
+This section will be using files from: 
+
+https://gitlab.com/BuildStream/buildstream/tree/master/integration-tests/cmake-test/
+
+Setup
+----
+
+If using docker, run::
+
+  bst-here 
+
+in the directory you want to use
+
+Create a project directory and in it create the following directories:
+    elements, elements/dependencies, keys, src
+
+install wget or some other download tool
+
+----
+
+Download https://gitlab.com/BuildStream/buildstream/raw/master/integration-tests/cmake-test/src/step7.tar.gz
+
+This should provide you with step7.tar.gz
+
+Move step7.tar.gz to src
+
+----
+
+Download https://gitlab.com/BuildStream/buildstream/raw/master/integration-tests/cmake-test/keys/gnome-sdk.gpg
+
+This should provide you with gnome-sdk.gpg
+
+Move gnome-sdk.gpg to keys
+
+Creating the project files
+----
+
+Project.conf
+~~~~
+
+In the root of the project directory create a file called project.conf containing::
+
+  name: Tim
+  element-path: elements
+  aliases:
+    gnomesdk: https://sdk.gnome.org/
+
+step7.bst
+~~~~
+
+In the elements directory Create a file called step7.bst containing::
+
+  kind: cmake
+  description: Cmake test
+  
+  depends:
+    - filename: dependencies/base-platform.bst
+      type: build
+    - filename: dependencies/base-sdk.bst
+      type: build
+  
+  sources:
+    - kind: tar
+      url: file:/src/step7.tar.gz
+      ref: 9591707afbae77751730b4af4c52a18b1cdc4378237bc64055f099bc95c330db
+  
+base-sdk.bst
+~~~~
+
+In the elements/dependencies directory Create a file called base-sdk.bst containing::
+
+  kind: import
+  description: Import the base freedesktop SDK
+  sources:
+  - kind: ostree
+    url: gnomesdk:repo/
+    gpg-key: keys/gnome-sdk.gpg
+    track: runtime/org.freedesktop.BaseSdk/x86_64/1.4
+    ref: 0d9d255d56b08aeaaffb1c820eef85266eb730cb5667e50681185ccf5cd7c882
+  config:
+    source: files
+    target: usr
+
+base-platform.bst
+~~~~
+
+In the elements/dependencies directory Create a file called base-platform.bst containing::
+
+  kind: import
+  description: Import the base freedesktop platform
+  sources:
+  - kind: ostree
+    url: gnomesdk:repo/
+    gpg-key: keys/gnome-sdk.gpg
+    track: runtime/org.freedesktop.BasePlatform/x86_64/1.4
+    ref: c9d09b7250a12ef09d95952fc4f49a35e5f8c2c1dd7141b7eeada4069e6f6576
+  config:
+    source: files
+  public:
+    bst:
+      integration-commands:
+      - ldconfig
+ 
+Building
+----
+
+From the project root directory run::
+
+  bst build step7.bst
+
+bst :ref:`_invoking_build` step7.bst
+
diff --git a/doc/source/index.rst b/doc/source/index.rst
index e62e23492..f5e86ecbe 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -24,7 +24,7 @@ Installing
 * :ref:`installing`
 * :ref:`docker`
 * :ref:`artifacts`
-
+* :ref:`createproject`
 
 Running
 -------
diff --git a/doc/source/invoking.rst b/doc/source/invoking.rst
index 94d4c8124..2f710d1fd 100644
--- a/doc/source/invoking.rst
+++ b/doc/source/invoking.rst
@@ -6,6 +6,8 @@ Invoking BuildStream
 .. click:: buildstream._frontend.main:cli
    :prog: bst
 
+.. _invoking_build:
+
 .. click:: buildstream._frontend.main:build
    :prog: build