From 90fd18da87f58feb0fc389a65caa95f308b4817a Mon Sep 17 00:00:00 2001
From: Nathaniel Graff <nathaniel.graff@sifive.com>
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 <nathaniel.graff@sifive.com>
---
 doc/sphinx/userguide/installing.rst | 75 ++++++++++++++++++++++++++++++++++++-
 1 file changed, 74 insertions(+), 1 deletion(-)

(limited to 'doc/sphinx/userguide/installing.rst')

diff --git a/doc/sphinx/userguide/installing.rst b/doc/sphinx/userguide/installing.rst
index 8684923..6e57425 100644
--- a/doc/sphinx/userguide/installing.rst
+++ b/doc/sphinx/userguide/installing.rst
@@ -1,4 +1,77 @@
 Installing Freedom E SDK
 ========================
 
-Foo
+Supported Systems
+-----------------
+
+Freedom E SDK is supported on Linux, MacOS, and Windows.
+
+Linux support is officially provided to distributions we distribute
+builds of the RISC-V toolchain for. Currently, these distributions are
+
+- Ubuntu
+- CentOS
+
+We expect other Linux distributions to work as well, provided that the
+user can either run our provided toolchains on them or produce their own
+toolchain.
+
+Windows support is not directly provided by Freedom E SDK, but through
+our Integrated Development Environment, Freedom Studio.
+
+Prerequisites
+-------------
+
+To use this SDK, you will need the following software available on your machine:
+
+- GNU Make
+- Git
+- The RISC-V GNU Embedded Toolchain
+- RISC-V OpenOCD (for use with development board and FPGA targets)
+
+Install the RISC-V Toolchain and OpenOCD
+----------------------------------------
+
+The RISC-V GNU Toolchain and OpenOCD are available from `the SiFive Website <https://www.sifive.com/boards>`_.
+
+For OpenOCD and/or RISC-V GNU Toolchain, download the .tar.gz for your platform,
+and unpack it to your desired location. Then, set the ``RISCV_PATH`` and
+``RISCV_OPENOCD_PATH`` environment variables when using the tools:
+
+.. code-block:: bash
+
+   cp openocd-<date>-<platform>.tar.gz /my/desired/location/
+   cp riscv64-unknown-elf-gcc-<date>-<platform>.tar.gz /my/desired/location
+   cd /my/desired/location
+   tar -xvf openocd-<date>-<platform>.tar.gz
+   tar -xvf riscv64-unknown-elf-gcc-<date>-<platform>.tar.gz
+   export RISCV_OPENOCD_PATH=/my/desired/location/openocd
+   export RISCV_PATH=/my/desired/location/riscv64-unknown-elf-gcc-<date>-<version>
+
+Cloning the Repository
+----------------------
+
+This repository can be cloned by running the following commands:
+
+.. code-block:: bash
+
+   git clone --recursive https://github.com/sifive/freedom-e-sdk.git
+   cd freedom-e-sdk
+
+The ``--recursive`` option is required to clone the git submodules included in the
+repository. If at first you omit the ``--recursive`` option, you can achieve
+the same effect by updating submodules using the command:
+
+.. code-block:: bash
+
+   git submodule update --init --recursive
+
+Updating the SDK
+----------------
+
+If you'd like to update your SDK to the latest version:
+
+.. code-block:: bash
+
+   git pull origin master
+   git submodule update --init --recursive
-- 
cgit v1.2.1-18-gbd029