Skip to content

Commit a09e123

Browse files
authored
Merge pull request mvallim#28 from mvallim/readme-environments-definition
Update readme to more clearly specify build/live/target systems
2 parents 91d4706 + 597793c commit a09e123

File tree

1 file changed

+21
-3
lines changed

1 file changed

+21
-3
lines changed

README.md

Lines changed: 21 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,15 @@ This procedure shows how to create a **bootable** and **installable** Ubuntu Liv
1414

1515
[![build-focal](https://github.com/mvallim/live-custom-ubuntu-from-scratch/actions/workflows/build-focal.yml/badge.svg)](https://github.com/mvallim/live-custom-ubuntu-from-scratch/actions/workflows/build-focal.yml)
1616

17+
## Terms
18+
19+
* `build system` - the computer environment running the build scripts that generate the ISO.
20+
* `live system` - the computer environment that runs from the live OS, generated by a `build system`. This may also be referred to as the `chroot environment`.
21+
* `target system` - the computer environment that runs after installation has completed from a `live system`.
22+
1723
## Prerequisites (GNU/Linux Debian/Ubuntu)
1824

19-
Install applications we need to build the environment.
25+
Install packages we need in the `build system` required by our scripts.
2026

2127
```shell
2228
sudo apt-get install \
@@ -35,6 +41,8 @@ mkdir $HOME/live-ubuntu-from-scratch
3541

3642
## Bootstrap and Configure Ubuntu
3743

44+
`debootstrap` is a program for generating OS images. We install it into our `build system` to begin generating our ISO.
45+
3846
* Checkout bootstrap
3947

4048
```shell
@@ -64,6 +72,8 @@ mkdir $HOME/live-ubuntu-from-scratch
6472

6573
> Reference: https://en.wikipedia.org/wiki/Chroot
6674
75+
From this point we will be configuring the `live system`.
76+
6777
1. **Access chroot environment**
6878

6979
```shell
@@ -399,6 +409,8 @@ sudo umount $HOME/live-ubuntu-from-scratch/chroot/run
399409
400410
## Create the CD image directory and populate it
401411
412+
We are now back in our `build environment` after setting up our `live system` and will continue creating files necessary to generate the ISO.
413+
402414
1. Access build directory
403415
404416
```shell
@@ -492,7 +504,8 @@ sudo umount $HOME/live-ubuntu-from-scratch/chroot/run
492504
493505
## Create manifest
494506
495-
In the next steps the creation of the manifest is important because it tells us which version of each package installed in the Live version and which packages will be removed or maintained in the version that will be installed (persisted in the hard drive).
507+
Next we create a file `filesystem.manifest` to specify each package and it's version that is installed on the `live system`. We create another file `filesystem.manifest-desktop` which specifies which files will be installed on the `target system`. Once the Ubiquity installer completes, it will
508+
remove packages specified in `filesystem.manifest` that are *not* listed in `filesystem.manifest-desktop`.
496509
497510
1. Access build directory
498511
@@ -520,7 +533,7 @@ In the next steps the creation of the manifest is important because it tells us
520533
521534
## Compress the chroot
522535
523-
After everything has been installed and preconfigured in the **chrooted** environment, we need to generate an image of everything that was done by following the next steps.
536+
After everything has been installed and preconfigured in the **chrooted** environment, we need to generate an image of everything that was done by following the next steps in the `build environment`.
524537
525538
1. Access build directory
526539
@@ -728,6 +741,11 @@ It is simple and easy, using "dd"
728741
```shell
729742
sudo dd if=ubuntu-from-scratch.iso of=<device> status=progress oflag=sync
730743
```
744+
745+
## Summary
746+
747+
This completes the process of creating a live Ubuntu installer from scratch. The generated ISO may be tested in a virtual machine such as `VirtualBox` or written to media and booted from a standard PC.
748+
731749
## Contributing
732750
733751
Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.

0 commit comments

Comments
 (0)