diff options
| author | Nathaniel Graff <nathaniel.graff@sifive.com> | 2019-02-01 10:23:47 -0800 |
|---|---|---|
| committer | Nathaniel Graff <nathaniel.graff@sifive.com> | 2019-02-06 11:09:41 -0800 |
| commit | 90fd18da87f58feb0fc389a65caa95f308b4817a (patch) | |
| tree | d3e578d05889fd08bfa05b49b50c81b66effb4fb /doc/sphinx/userguide/buildingcoreip.rst | |
| parent | 0df6996fcbd3cdfbb7614b4fcc7e83e41cea1f23 (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/buildingcoreip.rst')
| -rw-r--r-- | doc/sphinx/userguide/buildingcoreip.rst | 29 |
1 files changed, 29 insertions, 0 deletions
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 + |
