diff options
author | Nathaniel Graff <nathaniel.graff@sifive.com> | 2019-02-06 19:15:22 +0000 |
---|---|---|
committer | GitHub <noreply@github.com> | 2019-02-06 19:15:22 +0000 |
commit | 30837cf2279ec60989898a0d8ef5a1934bd443c0 (patch) | |
tree | 40b70bb9de7ec17e6ce5e8b876eaad0a07a210e1 /doc/sphinx/userguide/buildingcoreip.rst | |
parent | 4c20f5158e506f3c13cf66d5259a6399a6b4b2a3 (diff) | |
parent | 8565ab59da981d542febae1e93281c09c447c50c (diff) |
Merge pull request #169 from sifive/documentation
Add initial documentation
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 + |