summaryrefslogtreecommitdiffstats
path: root/doc/intro.rst
diff options
context:
space:
mode:
authorRobert Schwebel <r.schwebel@pengutronix.de>2017-06-13 17:38:19 +0200
committerRobert Schwebel <r.schwebel@pengutronix.de>2017-06-26 10:24:09 +0200
commitba9ebc41d68796af335f0fcce4888a332936cea8 (patch)
tree853f8493b3351b22898fbe955f8a47afffb3f5b9 /doc/intro.rst
parent4f3e49be463a1f08c6c0fcc61cf81bb7052edce4 (diff)
downloadDistroKit-ba9ebc41d68796af335f0fcce4888a332936cea8.tar.gz
DistroKit-ba9ebc41d68796af335f0fcce4888a332936cea8.tar.xz
doc: add sphinx/rst based documentation
Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
Diffstat (limited to 'doc/intro.rst')
-rw-r--r--doc/intro.rst48
1 files changed, 48 insertions, 0 deletions
diff --git a/doc/intro.rst b/doc/intro.rst
new file mode 100644
index 0000000..f02c4af
--- /dev/null
+++ b/doc/intro.rst
@@ -0,0 +1,48 @@
+Introduction
+============
+
+DistroKit is a Board Support Package (BSP) for the `PTXdist
+<http://www.ptxdist.org>`_ build system. It assembles a small (but not
+minimalistic) Embedded Linux system with modern components:
+
+- barebox bootloader
+- mainline kernel, as patch free as possible
+- systemd based init
+- NetworkManager for dbus based network configuration
+
+It can be used as a base for further BSP development.
+
+Installing the BSP
+------------------
+
+DistroKit is built with ptxdist. In order to install ptxdist,
+`download the tarball <http://www.pengutronix.de/software/ptxdist/download/ptxdist-|ptxdistVendorVersion|.tar.bz2>`_
+from the PTXdist Download Area.
+
+Extract the tarball:
+
+::
+
+ $ tar xf ptxdist-|ptxdistVendorVersion|.tar.bz2 && cd ptxdist-|ptxdistVendorVersion|
+
+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
+
+ `<http://www.pengutronix.de/oselas/toolchain/download/>`_
+
+and build them manually.
+