diff options
| author | John Ogness <john.ogness@linutronix.de> | 2018-04-18 16:49:12 +0200 |
|---|---|---|
| committer | John Ogness <john.ogness@linutronix.de> | 2018-04-18 16:49:12 +0200 |
| commit | 5c66f014bbb6f444ad28351d74dfa9faf39e9a8b (patch) | |
| tree | 3bead718137a135dc29a081b8d1d755783b16f06 /README | |
| parent | 062ef433f8690566a898e05fdd7c9af342c0d213 (diff) | |
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 <john.ogness@linutronix.de>
Diffstat (limited to 'README')
| -rw-r--r-- | README | 90 |
1 files changed, 60 insertions, 30 deletions
@@ -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. |