summaryrefslogtreecommitdiff
path: root/doc/sphinx/userguide/standalone.rst
diff options
context:
space:
mode:
authorNathaniel Graff <nathaniel.graff@sifive.com>2019-02-01 10:23:47 -0800
committerNathaniel Graff <nathaniel.graff@sifive.com>2019-02-06 11:09:41 -0800
commit90fd18da87f58feb0fc389a65caa95f308b4817a (patch)
treed3e578d05889fd08bfa05b49b50c81b66effb4fb /doc/sphinx/userguide/standalone.rst
parent0df6996fcbd3cdfbb7614b4fcc7e83e41cea1f23 (diff)
Copy the contents of the README into the User Guide
Signed-off-by: Nathaniel Graff <nathaniel.graff@sifive.com>
Diffstat (limited to 'doc/sphinx/userguide/standalone.rst')
-rw-r--r--doc/sphinx/userguide/standalone.rst14
1 files changed, 14 insertions, 0 deletions
diff --git a/doc/sphinx/userguide/standalone.rst b/doc/sphinx/userguide/standalone.rst
new file mode 100644
index 0000000..58f7f51
--- /dev/null
+++ b/doc/sphinx/userguide/standalone.rst
@@ -0,0 +1,14 @@
+Creating a Standalone Project
+=============================
+
+You can export a program to a standalone project directory using the ``standalone``
+target. The resulting project will be locked to a specific ``TARGET``. Note
+that this functionality is only supported for Freedom Metal programs, not the
+Legacy Freedom E SDK.
+
+``STANDALONE_DEST`` is a required argument to provide the desired project location.
+
+.. code-block:: bash
+
+ make BSP=mee [PROGRAM=hello] [TARGET=sifive-hifive1] STANDALONE_DEST=/path/to/desired/location standalone
+