DistroKit Mailinglist
 help / color / mirror / Atom feed
From: Roland Hieber <rhi@pengutronix.de>
To: distrokit@pengutronix.de
Cc: Roland Hieber <rhi@pengutronix.de>
Subject: [DistroKit] [PATCH 1/3] doc: restructure the quick start steps in the intro
Date: Fri,  4 Sep 2020 17:54:05 +0200	[thread overview]
Message-ID: <20200904155407.8599-1-rhi@pengutronix.de> (raw)
In-Reply-To: <20200904125234.rdht7b7uj7h2cdwv@pengutronix.de>

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 :-)



 doc/hardware.rst |  2 ++
 doc/intro.rst    | 43 ++++++++++++++++++++++++++++++-------------
 2 files changed, 32 insertions(+), 13 deletions(-)

diff --git a/doc/hardware.rst b/doc/hardware.rst
index 2143b6c0120d..8ac2b0216f95 100644
--- a/doc/hardware.rst
+++ b/doc/hardware.rst
@@ -1,3 +1,5 @@
+.. _hardware-platforms:
+
 Hardware Platforms
 ==================
 
diff --git a/doc/intro.rst b/doc/intro.rst
index b8278344f1ca..86db13707726 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
 ------------
-- 
2.28.0


_______________________________________________
DistroKit mailing list
DistroKit@pengutronix.de

       reply	other threads:[~2020-09-04 15:54 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
     [not found] <20200904125234.rdht7b7uj7h2cdwv@pengutronix.de>
2020-09-04 15:54 ` Roland Hieber [this message]
2020-09-04 15:54   ` [DistroKit] [PATCH 2/3] doc: hardware: strip down boilerplate documentation Roland Hieber
2020-09-04 15:54   ` [DistroKit] [PATCH 3/3] doc: hardware: add toctrees for mips and x86_64 Roland Hieber

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20200904155407.8599-1-rhi@pengutronix.de \
    --to=rhi@pengutronix.de \
    --cc=distrokit@pengutronix.de \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox