From 5c66f014bbb6f444ad28351d74dfa9faf39e9a8b Mon Sep 17 00:00:00 2001 From: John Ogness Date: Wed, 18 Apr 2018 16:49:12 +0200 Subject: docs: create a useful README Remove the outdated/useless INSTALL, README, and README.txt files and create a new and useful README. Signed-off-by: John Ogness --- INSTALL | 7 ----- README | 90 +++++++++++++++++++++++++++++++++++++++++--------------------- README.txt | 5 ---- 3 files changed, 60 insertions(+), 42 deletions(-) delete mode 100644 INSTALL delete mode 100644 README.txt diff --git a/INSTALL b/INSTALL deleted file mode 100644 index 8606d43..0000000 --- a/INSTALL +++ /dev/null @@ -1,7 +0,0 @@ -Buildsystem für Linutronix-Schulungsunterlagen -============================================== - -Voraussetzungen -=============== - -lx-cd: git clone ssh://tglx.de/home/linutronix/git/lx-cd diff --git a/README b/README index fbf378f..1bfcc41 100644 --- a/README +++ b/README @@ -1,30 +1,60 @@ -Hinweise zu Linutronix-Schulungsunterlagen -========================================== - -./linux-basics -./linux-basics/what-is-linux -./linux-basics/filesystem-structure -./linux-basics/boot-process -./linux-basics/linux-processes -./linux-basics/sh-programming -./linux-basics/important-tools - -./application-devel -./application-devel/compile-tools -./application-devel/devel-environment -./application-devel/devel-best-practices -./application-devel/app-debugging -./application-devel/embedded-devel - -./kernel-devel -./kernel-devel/kernel-basics -./kernel-devel/kernel-build -./kernel-devel/driver-basics -./kernel-devel/char-device -./kernel-devel/uio-driver -./kernel-devel/kernel-best-practices - -./realtime -./realtime/rt-basics -./realtime/rt-specialties -./realtime/rt-app-basics +Build System for Linutronix Training Slides/Handouts +---------------------------------------------------- + +Requirements +~~~~~~~~~~~~ + +The Linutronix package `lx-cd` must be manually installed: + +---- +$ git clone lxcvs:linutronix/lx-cd +$ cd lx-cd +$ dpkg-buildpackage -us -uc +$ cd .. +$ sudo dpkg -i lx-cd_2.0_all.deb +$ sudo apt-get -f install +---- + + +The rest of the required packages are within Debian: + +---- +$ sudo apt-get install gcc gperf make bison flex \ + libncurses5-dev latexmk texlive-xetex lx-cd +---- + + +Generate Slides/Handouts +~~~~~~~~~~~~~~~~~~~~~~~~ + +The material to generate is chosen using the kconfig menu system: + +---- +$ make menuconfig +---- + + +To generate the material: + +---- +$ make +---- + +The generated PDF files are located in the `deploy` directory. + + +Debugging +~~~~~~~~~ + +If there are errors generating the material, consider building with +verbose mode: + +---- +$ make V=2 +---- + + +Known Issues +~~~~~~~~~~~~ + + * Building in parallel using `-j` is not supported. diff --git a/README.txt b/README.txt deleted file mode 100644 index ac3c7f9..0000000 --- a/README.txt +++ /dev/null @@ -1,5 +0,0 @@ -At first you should configure and build kconfig-frontends. - -cd kconfig-frontends -./conigure -make -- cgit v1.2.3