path: root/README
diff options
authorJan Luebbe <>2013-07-14 12:42:35 +0200
committerJan Luebbe <>2013-07-14 12:42:35 +0200
commit1efb6cc0c3d6df59c6b56c97616495e8cd316e51 (patch)
tree8b7b48dba1534b09ba7be3340837c82a5c3b88e2 /README
parent53139a4f8cbec1f3c0f8353605e55861a795c974 (diff)
distrokit: add README files for DistroKit and platforms
Signed-off-by: Jan Luebbe <>
Diffstat (limited to 'README')
1 files changed, 67 insertions, 16 deletions
diff --git a/README b/README
index c9a3b2b..c6a9d4b 100644
--- a/README
+++ b/README
@@ -1,26 +1,77 @@
-This PTXdist[1] based project combines two reference board support packages:
+This is the main repository for DistroKit, an Embedded Linux Board
+Support Package (BSP) for the PTXdist [1] Build System.
-- ARM based "versatilepb"
-- X86 generic PC
+The main task for PTXdist is to build a root filesystem and a flash
+image for the embedded system. PTXdist has a concept of separating the
+software configuration from the hardware platforms, so the first
+decision to be made is to select for which hardware DistroKit shall be
-They are intended to show new users of ptxdist how to prepare and build all
-required components for an embedded device.
-For further information please read the following documents (part of this
+Installing PTXdist
-For the generic PC (x86 architecture):
+DistroKit is built with ptxdist. In order to install ptxdist, download
+the tarball from [2]:
-For the "versatilepb" (ARM architecture):
+$ wget \
-More PTXdist related information can be found at [1].
+Extract the tarball:
+$ tar xf ptxdist-2013.05.0 && cd ptxdist-2013.05.0
-Your Pengutronix Development Team
+Go to the extracted directory and run
+$ ./configure && make && sudo make install
+Selecting the Platform
+For the different hardware platforms, see the instructions about
+- how to install the toolchain
+- how to select the right platform
+- how to build the rootfs
+in README.<platform>.
+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:
+If you want to build the toolchain yourself, you can download the
+toolchain sources from
+and build them manually.
+Building DistroKit
+Now everything is prepared to build the BSP:
+$ ptxdist go
+PTXdist determines the number of CPUs on your computer and runs the
+compiler with <twice the number of CPUs> instances in parallel.
+Nevertheless, building a root filesystem from the sources needs some
+[1] PTXdist
+[2] PTXdist Download Area