aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md114
1 files changed, 59 insertions, 55 deletions
diff --git a/README.md b/README.md
index 2e83a7b..a85a317 100644
--- a/README.md
+++ b/README.md
@@ -15,11 +15,9 @@ Table of Contents
15 * Maintainers 15 * Maintainers
16 * Quick Start 16 * Quick Start
17 * Directory Structure 17 * Directory Structure
18 * Configuring and Downloading Images 18 * Distro Definition
19 * Creating Images 19 * Compatibility
20 * Bootable ISO Images 20 * Source Code
21 * Bootable Disk Images
22 * Bootable USB Pen Drives
23 21
24 22
25Disclaimer 23Disclaimer
@@ -45,6 +43,26 @@ Maintainers
45 david@syzdek.net 43 david@syzdek.net
46 44
47 45
46Requirements
47============
48
49Build requirements:
50
51 * Bash shell
52 * GNU Make
53 * GNU Mtools
54 * GNU GCC
55 * wget
56 * GNU Grub 2
57 * cdrtools
58
59Network boot requirements:
60
61 * DHCP Server (dnsmasq configuration included)
62 * TFTP Server (dnsmasq configuration included)
63 * HTTP Server (busybox httpd widget instructions included)
64
65
48Quick Start 66Quick Start
49=========== 67===========
50 68
@@ -56,7 +74,7 @@ Quick Start
56 74
57 make download 75 make download
58 76
59 Make disk ISO and USB images in `images/`: 77 Make ISO image and USB images in `images/`:
60 78
61 make images 79 make images
62 80
@@ -68,25 +86,41 @@ Quick Start
68Directory Structure 86Directory Structure
69=================== 87===================
70 88
71 * boot/<distro>/<ver>/<arch> 89 * `EFI/BOOT/` - UEFI boot files
72 * docs/ 90 * `boot/<distro>/` - Distribution images
73 * images/ 91 * `boot/grub/` - Grub binaries and configurations
74 * src/distros/<distro>/broken.efi 92 * `doc/` - Additional documentation
75 * src/distros/<distro>/cfg.footer 93 * `images/` - Generated IPERD images
76 * src/distros/<distro>/cfg.header 94 * `src/distros/<distro>/` - Distro definition
77 * src/distros/<distro>/cfg.label 95 * `src/grub/` - Grub templates and build files
78 * src/distros/<distro>/cfg.label.iso 96 * `src/scripts/` - helper scripts
79 * src/distros/<distro>/cfg.label.pxe 97 * `src/syslinux/` - Syslinux templates and build files
80 * src/distros/<distro>/cfg.label.sys 98 * `tmp/` - Download and build cache
81 * src/distros/<distro>/make.boot 99 * `var/config/` - Configuration files
82 * src/distros/<distro>/make.footer 100
83 * src/distros/<distro>/make.header 101
84 * src/distros/<distro>/option 102Distro Definition
85 * src/distros/<distro>/options 103-----------------
86 * src/scripts/ 104
87 * src/syslinux 105 * `./broken` - existence indicates broken distro
88 * tmp/ 106 * `./broken.efi` - existence indicates broken UEFI implementation
89 * var/config/ 107 * `./broken.iso` - existence indicates broken ISO implementation
108 * `./broken.pxe` - existence indicates broken PXE implementation
109 * `./broken.sys` - existence indicates broken USB implementation
110 * `./cfg.header` - start of syslinux configuration
111 * `./cfg.header.iso.efi` - start of grub configuration for UEFI ISO
112 * `./cfg.label` - default syslinux label template
113 * `./cfg.label.iso` - syslinux label template for ISO images
114 * `./cfg.label.iso.efi` - grub menuentry template for UEFI ISO images
115 * `./cfg.label.pxe` - syslinux label template for PXE labels
116 * `./cfg.label.sys` - syslinux label template for USB labels
117 * `./cfg.footer` - end of syslinux configuration
118 * `./cfg.footer.iso.efi` - end of grub configuration for UEFI ISO
119 * `./make.header` - start of Makefile definitions for distro
120 * `./make.boot` - Makefile targets for distro
121 * `./make.footer` - end of Makefile definitions for distro
122 * `./option` - list of distro variants (single option)
123 * `./options` - list of distro variants (multiple options)
90 124
91 125
92Compatibility 126Compatibility
@@ -111,36 +145,6 @@ Compatibility
111 +-------------------+-----+-----+-----+-----+-----+-----+-----+-----+-----+ 145 +-------------------+-----+-----+-----+-----+-----+-----+-----+-----+-----+
112 146
113 147
114Configuring and Downloading Images
115==================================
116
117To be written.
118
119
120Creating Images
121===============
122
123To be written.
124
125
126Creating Images: Bootable ISO Images
127------------------------------------
128
129To be written.
130
131
132Creating Images: Bootable Disk Images
133-------------------------------------
134
135To be written.
136
137
138Creating Images: Bootable USB Pen Drives
139----------------------------------------
140
141To be written.
142
143
144Source Code 148Source Code
145=========== 149===========
146 150