works nicely from the floppy
[bootsplash] / README.md
1 Bootsplash
2 ----------
3 Small bootable program that shows a splash effect every time you boot it up, and
4 when you hit any key on the keyboard, it proceeds to load the actual system (or
5 your regular boot loader) off the hard drive.
6
7
8 Author: John Tsiombikas <nuclear@member.fsf.org>
9
10 Not copyrighted, public domain software. Feel free to use it any way you like.
11 If public domain is not legally recognized in your country, you may instead use
12 it under the terms of the Creative Commons CC0 license.
13
14 Future improvements (TODO list):
15
16   - Option to load active partition instead of MBR from the selected boot device
17     to make bootsplash itself installable on the MBR (as it is, it would just
18     infinitely load itself).
19   - Add BIOS parameter block and fake partition table, to make it more likely
20     to be loadable from a USB stick.
21   - Add timeout to boot automatically if no key is pressed for a certain amount
22     of time.
23
24 Build
25 -----
26 To build bootsplash you need the netwide assembler (nasm). If you want to
27 customize the image used by the effect, you'll also need a C compiler to build
28 the RLE encoder under `rle`.
29
30 The data files are not in the repo. You'll need to get them from one of the
31 release archives.
32
33   - `nuclear.pgm`: 320x200 greyscale image used by the effect in binary Portable
34     GreyMap format.  This is fed into the `rle` encoder to produce `nuclear.rle`
35     which is `incbin`-ed into the bootsplash program.
36   - `fire.ppm`: 256x1 RGB image in binary Portable PixMap format. The header gets
37     stripped and the resulting `fire.pal` file is `incbin`-ed into the program.
38
39 If you don't want to customize the effect, simply copy the final files
40 (`nuclear.rle` and `fire.pal`) and type make.
41
42 To install onto a floppy, just use `dd`.