make documentation include temp patch

stanford-ppl · Mar 7, 2018 · 07680b0 · 07680b0
1 parent 430c10e
commit 07680b0
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 5 deletions.
diff --git a/docs/site/tutorial/starting.rst b/docs/site/tutorial/starting.rst
@@ -40,8 +40,6 @@ Installation From Maven (Recommended)
 
 .. highlight:: bash
 
-NOTE: This does not work right now.  ETA: March 8, 2018
-
 To get started with Spatial, you do not need to clone or build any DSL software yourself. 
 You simply need to create a new SBT project as follows::
 
@@ -75,12 +73,20 @@ In ``spatial-lang/``, create a file called ``build.sbt``::
 
 .. highlight:: bash
 
+NOTE: You will temporarily need to do the following because of resource files that are hardcoded
+into the compiler as of 3/7/2018 and this requirement will be removed shortly or a clean spatial-quickstart
+will be provided for you in future versions::
+
+	git clone git@github.com:stanford-ppl/spatial-lang
+	export SPATIAL_HOME=`pwd`/spatial-lang
+
 Finally, start writing your apps is ``spatial-lang/src/main/<filename>.scala``.  Refer to 
 `targets <../targets.html>`_ to learn how to compile the app.  The command is::
 
 	$ sbt "runMain <app name> <args>"
 
 
+
 Installation From Source
 --------------------------
 

diff --git a/docs/source/tutorial/dotproduct.rst b/docs/source/tutorial/dotproduct.rst
@@ -246,7 +246,7 @@ Final Code
 ----------
 
 Finally, below is the complete app that includes all of the performance-oriented features outlined in this page of the tutorial.
-Refer back to the `targets <../targets.rst>`_ section for a refresher on how to test your app.::
+Refer back to the `targets <../targets.html>`_ section for a refresher on how to test your app.::
 
     import spatial.dsl._
     import virtualized._

diff --git a/docs/source/tutorial/starting.rst b/docs/source/tutorial/starting.rst
@@ -40,8 +40,6 @@ Installation From Maven (Recommended)
 
 .. highlight:: bash
 
-NOTE: This does not work right now.  ETA: March 8, 2018
-
 To get started with Spatial, you do not need to clone or build any DSL software yourself. 
 You simply need to create a new SBT project as follows::
 
@@ -74,12 +72,20 @@ In ``spatial-lang/``, create a file called ``build.sbt``::
 
 .. highlight:: bash
 
+NOTE: You will temporarily need to do the following because of resource files that are hardcoded
+into the compiler as of 3/7/2018 and this requirement will be removed shortly or a clean spatial-quickstart
+will be provided for you in future versions::
+
+	git clone git@github.com:stanford-ppl/spatial-lang
+	export SPATIAL_HOME=`pwd`/spatial-lang
+
 Finally, start writing your apps is ``spatial-lang/src/main/<filename>.scala``.  Refer to 
 `targets <../targets.html>`_ to learn how to compile the app.  The command is::
 
 	$ sbt "runMain <app name> <args>"
 
 
+
 Installation From Source
 --------------------------