summaryrefslogtreecommitdiff
path: root/doc/sphinx/index.rst
diff options
context:
space:
mode:
authorNathaniel Graff <nathaniel.graff@sifive.com>2019-02-01 10:23:47 -0800
committerNathaniel Graff <nathaniel.graff@sifive.com>2019-02-06 11:09:41 -0800
commit90fd18da87f58feb0fc389a65caa95f308b4817a (patch)
treed3e578d05889fd08bfa05b49b50c81b66effb4fb /doc/sphinx/index.rst
parent0df6996fcbd3cdfbb7614b4fcc7e83e41cea1f23 (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/index.rst')
-rw-r--r--doc/sphinx/index.rst14
1 files changed, 14 insertions, 0 deletions
diff --git a/doc/sphinx/index.rst b/doc/sphinx/index.rst
index e680a68..a8f0809 100644
--- a/doc/sphinx/index.rst
+++ b/doc/sphinx/index.rst
@@ -8,12 +8,26 @@ 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