summaryrefslogtreecommitdiff
path: root/doc/sphinx/userguide/buildingdevboard.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/buildingdevboard.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/buildingdevboard.rst')
-rw-r--r--doc/sphinx/userguide/buildingdevboard.rst43
1 files changed, 43 insertions, 0 deletions
diff --git a/doc/sphinx/userguide/buildingdevboard.rst b/doc/sphinx/userguide/buildingdevboard.rst
new file mode 100644
index 0000000..4b5822b
--- /dev/null
+++ b/doc/sphinx/userguide/buildingdevboard.rst
@@ -0,0 +1,43 @@
+Building for a Dev Board or FPGA
+================================
+
+Building an Example
+-------------------
+
+To compile a bare-metal RISC-V program:
+
+.. code-block:: bash
+
+ make BSP=mee [PROGRAM=hello] [TARGET=sifive-hifive1] software
+
+The square brackets in the above command indicate optional parameters for the
+Make invocation. As you can see, the default values of these parameters tell
+the build script to build the ``hello`` example for the ``sifive-hifive1`` target.
+If, for example, you wished to build the ``timer-interrupt`` example for the S51
+Arty FPGA Evaluation target, you would instead run the command
+
+.. code-block:: bash
+
+ make BSP=mee PROGRAM=timer-interrupt TARGET=coreip-s51-arty software
+
+Uploading to the Target Board
+-----------------------------
+
+.. code-block:: bash
+
+ make BSP=mee [PROGRAM=hello] [TARGET=sifive-hifive1] upload
+
+Debugging a Target Program
+--------------------------
+
+.. code-block:: bash
+
+ make BSP=mee [PROGRAM=hello] [TARGET=sifive-hifive1] debug
+
+Cleaning a Target Program Build Directory
+-----------------------------------------
+
+.. code-block:: bash
+
+ make BSP=mee [PROGRAM=hello] [TARGET=sifive-hifive1] clean
+