diff options
author | Roland Hieber <rhi@pengutronix.de> | 2020-09-04 17:06:35 +0200 |
---|---|---|
committer | Roland Hieber <rhi@pengutronix.de> | 2020-09-04 17:53:04 +0200 |
commit | e9604ded10152d355cfcb724510a47fd6422a9bc (patch) | |
tree | 58be5ce4a60077fcf0a41a46348f21a8bc3d1a1a /doc/intro.rst | |
parent | 54cdf7345712af34224a7f4dc06a9f75f45af0ff (diff) | |
download | DistroKit-e9604ded10152d355cfcb724510a47fd6422a9bc.tar.gz DistroKit-e9604ded10152d355cfcb724510a47fd6422a9bc.tar.xz |
doc: restructure the quick start steps in the intro
Give a brief documentation on how to install the correct PTXdist and
toolchain versions, and update outdated links to the PTXdist homepage.
Signed-off-by: Roland Hieber <rhi@pengutronix.de>
---
Robert, this relies on updated documentation on the PTX homepage. Please
merge www.pengutronix.de, branch rhi/topic/toolchain-install first :-)
Diffstat (limited to 'doc/intro.rst')
-rw-r--r-- | doc/intro.rst | 43 |
1 files changed, 30 insertions, 13 deletions
diff --git a/doc/intro.rst b/doc/intro.rst index b827834..86db137 100644 --- a/doc/intro.rst +++ b/doc/intro.rst @@ -12,10 +12,27 @@ minimalistic) Embedded Linux system with modern components: It can be used as a base for further BSP development. -Installing the BSP ------------------- +DistroKit supports multiple hardware platforms, see chapter +:ref:`hardware-platforms` for more information about them. -DistroKit is built with ptxdist. In order to install ptxdist, + +Quick Start +----------- + +The next sections below describe briefly how to build the BSP from scratch, +but for more in-depth documentation, refer to the `PTXdist manual +<https://www.ptxdist.org/doc/>`_ (or the later chapters if you're reading this +documentation in the HTML or the PDF version). + +If you already have a working environment, you can skip to the section about the +individual :ref:`hardware-platforms` for more information on how to build +images, how to flash an image to a board, or how to get a serial console. + +Installing PTXdist +~~~~~~~~~~~~~~~~~~ + +DistroKit is built with PTXdist version |ptxdistVendorVersion|. In order to +install PTXdist, `download the tarball <http://www.pengutronix.de/software/ptxdist/download/ptxdist-|ptxdistVendorVersion|.tar.bz2>`_ from the PTXdist Download Area. @@ -32,19 +49,19 @@ Go to the extracted directory and run $ ./configure && make && sudo make install Installing the Toolchain ------------------------- - -In order to build a BSP, you need a toolchain. The easiest way to get a -toolchain is to install the debian packages for OSELAS.Toolchain: - - `<http://www.pengutronix.de/oselas/toolchain/>`_ +~~~~~~~~~~~~~~~~~~~~~~~~ -If you want to build the toolchain yourself, you can download the -toolchain sources from +In order to build a BSP for a different architecture than your host system, +you need a toolchain. +DistroKit is configured for the OSELAS.Toolchain |oselasTCNVendorVersion|. +Depending on the platform you want to build, different toolchains are necessary – +see the sections about the :ref:`hardware-platforms`. - `<http://www.pengutronix.de/oselas/toolchain/download/>`_ +Pre-built Debian packages of the toolchains are available from Pengutronix, +but you can also build the toolchain from source. +See the `OSELAS.Toolchain homepage <https://www.pengutronix.de/de/software/toolchain.html>`_ +for more information. -and build them manually. Contributing ------------ |