From 0df6996fcbd3cdfbb7614b4fcc7e83e41cea1f23 Mon Sep 17 00:00:00 2001 From: Nathaniel Graff Date: Tue, 29 Jan 2019 13:32:11 -0800 Subject: Init Sphinx docs for E SDK Signed-off-by: Nathaniel Graff --- doc/sphinx/index.rst | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 doc/sphinx/index.rst (limited to 'doc/sphinx/index.rst') diff --git a/doc/sphinx/index.rst b/doc/sphinx/index.rst new file mode 100644 index 0000000..e680a68 --- /dev/null +++ b/doc/sphinx/index.rst @@ -0,0 +1,24 @@ +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 + +Table of Contents +----------------- + +.. toctree:: + :maxdepth: 2 + + userguide + + +Indices and tables +------------------ + +* :ref:`genindex` +* :ref:`search` -- cgit v1.2.1-18-gbd029 From 90fd18da87f58feb0fc389a65caa95f308b4817a Mon Sep 17 00:00:00 2001 From: Nathaniel Graff Date: Fri, 1 Feb 2019 10:23:47 -0800 Subject: Copy the contents of the README into the User Guide Signed-off-by: Nathaniel Graff --- doc/sphinx/index.rst | 14 ++++++++++++++ 1 file changed, 14 insertions(+) (limited to 'doc/sphinx/index.rst') 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 `_. + Table of Contents ----------------- .. toctree:: :maxdepth: 2 + contents userguide -- cgit v1.2.1-18-gbd029