diff options
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` |