|
1 | 1 | # claylinux |
2 | 2 |
|
3 | | -Claylinux is a set of tools to build Linux bootable images using docker. It can produce raw disk images (`.img`), |
4 | | -CDROM/ISO images (`.iso`), pure EFI binaries (`.efi`), ... |
| 3 | +Claylinux is a tool to build and install [Bootable Containers](https://containers.github.io/bootable/) images. It |
| 4 | +allows you to build Linux-based operating systems (OS) using [Docker](https://www.docker.com/) or |
| 5 | +[Podman](https://podman.io/) tooling. Then, you can ship your OS images using [OCI](https://opencontainers.org/) image |
| 6 | +registries (e.g. [Docker Hub](https://hub.docker.com/), [GitHub Container Registry](https://ghcr.io), |
| 7 | +[Quay.io](https://quay.io/)...). This tool can also produce raw disk images (`.img`), CDROM/ISO images (`.iso`) and |
| 8 | +pure EFI binaries (`.efi`, also called |
| 9 | +[Unified Kernel Images](https://uapi-group.org/specifications/specs/unified_kernel_image/))... |
| 10 | + |
| 11 | +The difference between bootable container images and traditional container images is that bootable images also |
| 12 | +contain a Linux kernel and an init system in addition to the OS user-space. For that purpose, we provide base-images |
| 13 | +containing all you need to start building your OS image. |
5 | 14 |
|
6 | 15 | This project is currently a **WORK IN PROGRESS**, some breaking changes may happen at any time. |
7 | 16 |
|
8 | 17 |
|
9 | 18 | ## Getting Started |
10 | 19 |
|
11 | | -The Linux OS building process is the following: |
| 20 | +The process to follow to build an OS is the following: |
12 | 21 | 1. start from a base docker image which contains both the Linux OS userspace filesystem and a Linux kernel. For example, |
13 | | -you can use the `claylinux/alpine-lts` image which correspond to a [Alpine Linux](https://www.alpinelinux.org/) OS with |
| 22 | +you can use the `claylinux/alpine-lts` image which correspond to an [Alpine Linux](https://www.alpinelinux.org/) OS with |
14 | 23 | a [linux-lts](https://pkgs.alpinelinux.org/package/edge/main/x86_64/linux-lts) kernel. |
15 | 24 | 2. add software & configuration files to the image using a [Dockerfile](https://docs.docker.com/reference/dockerfile/). |
16 | 25 |
|
|
0 commit comments