path: root/README
diff options
authorRobert Schwebel <>2017-06-13 17:38:19 +0200
committerRobert Schwebel <>2017-06-26 10:24:09 +0200
commitba9ebc41d68796af335f0fcce4888a332936cea8 (patch)
tree853f8493b3351b22898fbe955f8a47afffb3f5b9 /README
parent4f3e49be463a1f08c6c0fcc61cf81bb7052edce4 (diff)
doc: add sphinx/rst based documentation
Signed-off-by: Robert Schwebel <>
Diffstat (limited to 'README')
1 files changed, 9 insertions, 70 deletions
diff --git a/README b/README
index e9f9801..e89ec47 100644
--- a/README
+++ b/README
@@ -1,77 +1,16 @@
-This is the main repository for DistroKit, an Embedded Linux Board
-Support Package (BSP) for the PTXdist [1] Build System.
+The documentation is now available in the doc/ directory, with the
+starting point at
-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
+ doc/intro.rst
+It can be built into HTML documentation with
-Installing PTXdist
+ $ ptxdist docs-html
-DistroKit is built with ptxdist. In order to install ptxdist, download
-the tarball from [2]:
+Then point your browser to
-$ wget \
-Extract the tarball:
-$ tar xf ptxdist-2016.01.0 && cd ptxdist-2016.01.0
-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 images
-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
+ Documentation/html/index.html