From 90fd18da87f58feb0fc389a65caa95f308b4817a Mon Sep 17 00:00:00 2001 From: Nathaniel Graff Date: Fri, 1 Feb 2019 10:23:47 -0800 Subject: Copy the contents of the README into the User Guide Signed-off-by: Nathaniel Graff --- doc/sphinx/userguide/buildingcoreip.rst | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 doc/sphinx/userguide/buildingcoreip.rst (limited to 'doc/sphinx/userguide/buildingcoreip.rst') diff --git a/doc/sphinx/userguide/buildingcoreip.rst b/doc/sphinx/userguide/buildingcoreip.rst new file mode 100644 index 0000000..a6f1dae --- /dev/null +++ b/doc/sphinx/userguide/buildingcoreip.rst @@ -0,0 +1,29 @@ +Building for SiFive CoreIP +========================== + +Building an Example +------------------- + +To compile a bare-metal RISC-V program: + +.. code-block:: bash + + make BSP=mee [PROGRAM=hello] [TARGET=coreip-e31] 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 ``coreip-e31`` target. +If, for example, you wished to build the ``timer-interrupt`` example for the S51 +Core IP target, you would instead run the command + +.. code-block:: bash + + make BSP=mee PROGRAM=timer-interrupt TARGET=coreip-s51 software + +Cleaning a Target Program Build Directory +----------------------------------------- + +.. code-block:: bash + + make BSP=mee [PROGRAM=hello] [TARGET=coreip-e31] clean + -- cgit v1.2.1-18-gbd029