added README and license
[bootcensus] / README.md
1 pcboot
2 ======
3
4 This project is still in the early stages of initial hacking, so many of the
5 following are not implemented yet, but rather the concepts that will be fleshed
6 out in the future.
7
8 pcboot is a minimal 32 bit protected mode kernel, which can be used to make
9 bootable PC demos or games. It's not designed as a regular standalone operating
10 system kernel, and cannot be used as such. The intend is to link it with your
11 codebase, or more likely build your demo/game code around the pcboot kernel
12 code.
13
14 One of the core design principles is to allow starting pcboot programs from
15 either traditional floppy disks, or USB sticks, and possibly CD-ROMs as well.
16 The main idea is to make "down to the metal" PC hacking simpler, not requiring
17 the maintainance of purpose-build retro-PCs. Nor having to deal with the
18 inadequacies of MS-DOS, but rather follow a more Amiga-like approach of giving
19 the finger to the ugly software stack of that time, and talk to the hardware,
20 which is much more timeless and interesting, without middle-men.
21
22 A reasonable effort has been made to make porting DOS protected mode programs to
23 run under pcboot, but don't expect that just re-building your existing code will
24 work out of the box.
25
26 License
27 -------
28 Copyright (C) 2018  John Tsiombikas <nuclear@member.fsf.org>
29 This program is free software. Feel free to use, modify, and/or redistribute it
30 under the terms of the GNU General Public License version 3, or at your option,
31 any later version published by the Free Software Foundation. See COPYING for
32 details.
33
34 Yes, this means that if you release any programs which use pcboot, you will have
35 to release the source code as well, under the same terms.
36
37 Let's drop any pretence that you have any good reason to keep your code to
38 yourself. This is strictly a tool for retro-coding. There are no corporate
39 secrets in a bootable PC demo. You can do it. If you insist on not sharing the
40 code of whatever silly thing you make with the help of this, you can fuck right
41 off.