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/index.rst | |
| parent | 4c20f5158e506f3c13cf66d5259a6399a6b4b2a3 (diff) | |
| parent | 8565ab59da981d542febae1e93281c09c447c50c (diff) | |
Merge pull request #169 from sifive/documentation
Add initial documentation
Diffstat (limited to 'doc/sphinx/index.rst')
| -rw-r--r-- | doc/sphinx/index.rst | 38 |
1 files changed, 38 insertions, 0 deletions
diff --git a/doc/sphinx/index.rst b/doc/sphinx/index.rst new file mode 100644 index 0000000..a8f0809 --- /dev/null +++ b/doc/sphinx/index.rst @@ -0,0 +1,38 @@ +Freedom E SDK +============= + +This is the documentatino for the SiFive Freedom E SDK |version|. + +Freedom E SDK is generally available from the `Freedom E SDK Repository`_. + +.. _Freedom E SDK Repository: + https://github.com/sifive/freedom-e-sdk + +What is Freedom E SDK? +---------------------- + +Freedom E SDK is a project maintained by Sifive Inc. which makes it easy to +get started developing software for the Freedom E and Freedom S Embedded +RISC-V Platforms. + +**UNDER CONSTRUCTION** + +Freedom E SDK is currently under construction as we transition from the +legacy Freedom E SDK API to the new +`Freedom Metal Compatibility Library <https://github.com/sifive/freedom-metal>`_. + +Table of Contents +----------------- + +.. toctree:: + :maxdepth: 2 + + contents + userguide + + +Indices and tables +------------------ + +* :ref:`genindex` +* :ref:`search` |