saad/minimal
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Improved 'readme' docs.

Browse Source
This commit is contained in:
Ivan Davidov 2017-12-02 03:33:20 +02:00
parent dbfd661372
commit a0c11a3166
2 changed files with 26 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
README.md
View File

@ -42,7 +42,7 @@ The section below is for Ubuntu and other Debian based distros.
```
# Resove build dependencies
sudo apt install wget make gawk gcc bc genisoimage
sudo apt install wget make gawk gcc bc xorriso
# Build everything and produce ISO image.
./build_minimal_linux_live.sh
@ -52,22 +52,26 @@ The default build process uses some custom provided ``CFLAGS``. They can be foun
## Overlay bundles
**Important note!** The overlay bundles come without support since the build process for almost all of them is host specific and can vary significantly between different machines. Therefore the bundle build process is disabled by default.
**Important note!** Most of the overlay bundles come without support since the build process for almost all of them is host specific and can vary significantly between different machines. Some overlay bundles have no dependencies to the host machine, e.g. the DHCP functionality and the MLL source code generation which are enabled by default.
The current development version introduces the concept of ``overlay bundles``. During the boot process the ``OverlayFS`` driver merges the initramfs with the content of these bundles. Currently this is the mechanism which allows you to build additional software on top of MLL without touching the core build process. In fact the overlay bundle system has been designed to be completely independent from the MLL build process. You can build one or more overlay bundles without building MLL at all. However, some of the overlay bundles have dependencies on the software pieces provided by the MLL build process, so it is recommended to use the overlay build subsystem as last step before you produce the final ISO image.
The current development version introduces the concept of ``overlay bundles``. During the boot process the ``OverlayFS`` driver merges the initramfs with the content of these bundles. Currently this is the mechanism which allows you to build additional software on top of MLL without touching the core build process. In fact the overlay bundle system has been designed to be completely independent from the MLL build process. You can build one or more overlay bundles without building MLL at all. However, some of the overlay bundles have dependencies on the software pieces provided by the MLL build process, so it is recommended to use the overlay build subsystem after you have produced the 'initramfs' area.
The overlay build system provides dependency management. If bundle 'b' depends on bundle 'a' you don't need to build bundle 'a' manually in advance. The bundle dependencies are described in special metadata file ``bundle_deps`` and all such dependencies are prepared automatically.
```
# How to build all overlay bundles
# How to build all overlay bundles.
cd minimal_overlay
./overlay_build.sh
```
```
# How to build specific overlay bundle (e.g. links)
# How to build specific overlay bundle. The example is for 'Open JDK'
# which depends on many GNU C libraries and on ZLIB. All dependencies
# are handled automatically by the overlay build system.
cd minimal_overlay
./overlay_build.sh links
./overlay_build.sh openjdk
```
## BIOS and UEFI
@ -93,6 +97,16 @@ isohybrid minimal_linux_live.iso
dd if=minimal_linux_live.iso of=/dev/xxx
```
The build process also generates image the file ``mll_image.tgz``. This image contains everything from the initramfs area and everything from the overlay area, i.e. all overlay bundles that have been installed during the build process. You can import and use the image in Docker like this:
```
# Import the MLL image in Docker.
docker import mll_image.tgz minimal-linux-live:latest
# Run MLL shell in Docker:
docker run -it minimal-linux-live /bin/sh
```
## Projects based on Minimal Linux Live:
* [Minimal Linux Script](https://github.com/ivandavidov/minimal-linux-script) - very simplified and minimalistic version of MLL. This project is recommended as a starting point for beginners.

13
src/README
View File

@ -27,11 +27,11 @@ Currently available overlay bundles:
This overlay bundle depends on the GLIBC build process.
* coreutils - set of commonly used GNU executable utilities.
* coreutils - Set of commonly used GNU executable utilities.
* dhcp - DHCP and DNS functionality to connect to the Internet.
* dialog - shell scripting library for ncurses
* dialog - Shell scripting library for ncurses
This overlay bundle requires ncurses
@ -60,8 +60,8 @@ Currently available overlay bundles:
This overlay bundle requires GLIBC. JDK 9 requires ZLIB.
* kbd - Keyboard utilities and keymaps, you can for example load
a german keyboard layout:
* kbd - Keyboard utilities and keymaps. For example, you can load
German keyboard layout like this:
loadkeys de
@ -69,7 +69,7 @@ Currently available overlay bundles:
callback function when a specific event occurs on a file
descriptor or after a timeout has been reached.
* kexec-tools - Kexec tools, can be used to boot another kernel from userspace
* kexec_tools - Kexec tools, can be used to boot another kernel from userspace
* Links - Text based browser. Requires ~1MB additional space. Use the
"links" command to activate the browser.
@ -105,7 +105,7 @@ Currently available overlay bundles:
'-net nic,model=e1000 -net user,hostfwd=tcp::8080-:80' to
'cmd' in the qemu.sh file.
* stress - simple workload generator. Imposes a configurable amount of CPU,
* stress - Simple workload generator. Imposes a configurable amount of CPU,
memory, I/O, and disk stress on the system. stress is useful for
troubleshooting CPU and RAM.
@ -122,7 +122,6 @@ Currently available overlay bundles:
* ZLIB - Software library used for data compression.
### ### ###
I only provide the build scripts. It's entirely up to you to configure and