Fixing createproject.rst, adding links to pages

2 files changed, 29 insertions, 14 deletions

diff --git a/doc/source/createproject.rst b/doc/source/createproject.rst
index 9ed9c9ac1..879e23767 100644
--- a/doc/source/createproject.rst
+++ b/doc/source/createproject.rst
@@ -46,6 +46,7 @@ Source files
 There are multiple ways of including source files with build stream, and this is done though things called plugins.
 
 The list of options can be found here :ref:`plugins_sources`
+And each option can be clicked for an example of "element"
 
 
 If you plan on following along with this tutorial, do the following:
@@ -60,15 +61,16 @@ If you plan on following along with this tutorial, do the following:
 
     Move `step7.tar.gz` to `src`
 
-----
 
-Download https://gitlab.com/BuildStream/buildstream/raw/master/integration-tests/cmake-test/keys/gnome-sdk.gpg
+    Download https://gitlab.com/BuildStream/buildstream/raw/master/integration-tests/cmake-test/keys/gnome-sdk.gpg
 
-This should provide you with `gnome-sdk.gpg`
+    This should provide you with `gnome-sdk.gpg`
 
-Move `gnome-sdk.gpg` to `keys`
+    Move `gnome-sdk.gpg` to `keys`
 
+----
 
+Alternatively, you can link to your project using one of the options in sources or tar.gz your projects and use it in place of step7.tar.gz
 
 
 Creating the project files
@@ -79,18 +81,30 @@ Project.conf
 
 In the root of the project directory create a file called project.conf containing::
 
-  name: ProjectName  #The name you want to give to your project
-  element-path: elementsPath #The path to the "elements" directory
+  name: ProjectName  # The name you want to give to your project
+  element-path: elementsPath # The relative path to the "elements" directory
+  # The elements directory is where your .bst files will be stored 
   aliases:
-    name:url #This is used so you can moderate the URLs/Repos used by your build. 
-             #This way, they can be modified in a single place instead of multiple
+    name:url # This is used so you can moderate the URLs/Repos used by your build. 
+             # This way, they can be modified in a single place instead of multiple
+             # Use this name in place of the url anywhere you would use it  
+    gnomesdk: https://sdk.gnome.org/    
+    
+  options:
+     arch:
+       type: arch
+       description: The machine architecture
+       values:
+       - x86_64
+       - i386
+
 
 step7.bst
 ~~~~
 
 In the elements directory Create a file called step7.bst containing::
 
-  kind: cmake
+  kind: cmake #This is an element plugin (linked below)
   description: Cmake test
   
   depends:
@@ -100,11 +114,10 @@ In the elements directory Create a file called step7.bst containing::
       type: build
   
   sources:
-    - kind: tar
+    - kind: tar #This is a Source Plugin
       url: file:/src/step7.tar.gz
-      ref: 9591707afbae77751730b4af4c52a18b1cdc4378237bc64055f099bc95c330db
   
-:ref:`format_kind`
+:ref:`plugins_elements:`
 
 :ref:`format_depends`
 
@@ -124,7 +137,6 @@ In the elements/dependencies directory Create a file called base-sdk.bst contain
     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
@@ -143,7 +155,6 @@ In the elements/dependencies directory Create a file called base-platform.bst co
     url: gnomesdk:repo/
     gpg-key: keys/gnome-sdk.gpg
     track: runtime/org.freedesktop.BasePlatform/x86_64/1.4
-    ref: c9d09b7250a12ef09d95952fc4f49a35e5f8c2c1dd7141b7eeada4069e6f6576
   config:
     source: files
   public:
@@ -159,4 +170,6 @@ Building
 From the project root directory run:
 
   ``bst`` :ref:`invoking_build` ``step7.bst``
+  
+You can substitute step7.bst for your own .bst file
 
diff --git a/doc/source/pluginindex.rst b/doc/source/pluginindex.rst
index bcc20b5e9..2a74a11e5 100644
--- a/doc/source/pluginindex.rst
+++ b/doc/source/pluginindex.rst
@@ -19,6 +19,8 @@ General Elements
 * :mod:`compose <elements.compose>` - Compose the output of multiple elements
 * :mod:`script <elements.script>` - Run scripts to create output
 
+.. _plugins_elements:
+
 Build Elements
 ~~~~~~~~~~~~~~