wip backup update
[nyanlinux.git] / INSTALL
blobf19c2d6b293244bb11a3f74ee77c10675cadc7d6
1 The target audience of this custom UEFI x86_64 glibc/linux distro is:
2  - system developers
3  - advanced system administators
4  - advanced open source software enthusiasts
6 Either you build the bootstrap, or use a prebuilt bootstrap device image (at
7 the time of writing, no device image exists due to unavailable suitable online
8 storage).
10 MAIN METHOD: BUILDING THE BOOTSTRAP --------------------------------------------
11 Unfortunately, you need a relatively recent glibc/linux distro to build the
12 nyan bootstrap glibc/linux distro and you will need to get the source code
13 from internet yourself.
14 In theory, the nyan bootstrap glibc/linux distro should be able to bootstrap
15 itself.
17 You need to download the source files/clone the git source repositories in 
18 "$nyan_root/src" (we don't auto download them to avoid generating excess
19 traffic on source hosting servers if "mistakes" were to be made). Look
20 for "*url*" strings in builder.sh of the packages used in 00-bootstrap-build.sh.
22 You need to prepare a disk device with at least 2 partitions as the root user:
23  - one partition formatted as vfat/fat32 (minimum 128MB due to broken UEFI
24    implementations) for the UEFI bios
25  - one partition formatted for the root filesystem, which UUID/GUID you will
26    need to know.
28 Then, configure the bootstrap build onto those partitions in the
29 conf.bootstrap.sh file. You may have to fiddle with the advanced settings
30 to fit your glibc/linux distro.
32 Run 00-bootstrap-build.sh as the root user.
34 Boot from the device (USB key, disk, etc) using the boot menu from your UEFI
35 bios. Zero shell configuration was done. You won't even have a proper
36 configured PATH. That to let the users configure their shell(s) their way.
38 IMPORTANT NOTES: The bootstrap build was only tested on itself, not with other
39 glibc/linux distros. It means you will probably run into issues which will
40 require some advanced knowledge.
42 ALTERNATIVE METHOD: PREBUILT BOOTSTRAP DEVICE IMAGE ----------------------------
43 Not available since we don't have suitable online storage.
44 But it would be dead simple, for instance an USB key being installed with
45 "dd if=image_file of=/dev/sdX".