From 3befe372211c78951124b64faa2be25c108db1bd Mon Sep 17 00:00:00 2001 From: Sebastien Bourdeauducq Date: Wed, 22 Jun 2016 10:01:56 +0800 Subject: [PATCH] manual: minor cleanup --- doc/manual/installing.rst | 2 +- doc/manual/installing_from_source.rst | 13 ++++++------- 2 files changed, 7 insertions(+), 8 deletions(-) diff --git a/doc/manual/installing.rst b/doc/manual/installing.rst index c87a55f44..c3090337b 100644 --- a/doc/manual/installing.rst +++ b/doc/manual/installing.rst @@ -14,7 +14,7 @@ The conda package contains pre-built binaries that you can directly flash to you .. warning:: Conda packages are supported for Linux (64-bit) and Windows (32- and 64-bit). - Users of other operating systems (32-bit Linux, BSD, OSX ...) should and can :ref:`install from source `. + Users of other operating systems (32-bit Linux, BSD, OSX ...) should and can :ref:`install from source `. Installing Anaconda or Miniconda diff --git a/doc/manual/installing_from_source.rst b/doc/manual/installing_from_source.rst index ebfc69192..25cba44ae 100644 --- a/doc/manual/installing_from_source.rst +++ b/doc/manual/installing_from_source.rst @@ -1,15 +1,14 @@ -.. _install-from-sources: +.. _install-from-source: - -Installing ARTIQ from sources -============================= +Installing ARTIQ from source +============================ .. note:: This method is only recommended for developers and advanced users. An easier way to install ARTIQ is via the Anaconda packages (see :ref:`Installing ARTIQ `). Preparing the build environment for the core device -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +--------------------------------------------------- These steps are required to generate code that can run on the core device. They are necessary both for building the MiSoC BIOS @@ -59,7 +58,7 @@ and the ARTIQ kernels. Compilation of LLVM can take more than 30 min on some machines. Preparing the core device FPGA board -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +------------------------------------ These steps are required to generate gateware bitstream (``.bit``) files, build the MiSoC BIOS and ARTIQ runtime, and flash FPGA boards. If the board is already flashed, you may skip those steps and go directly to `Installing the host-side software`. @@ -164,7 +163,7 @@ to the serial device (``sudo adduser $USER dialout`` assuming standard setup). .. _installing-the-host-side-software: Installing the host-side software -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +--------------------------------- * Install the llvmlite Python bindings: ::