1.1 --- a/README	Sat Dec 04 10:12:39 2010 +0200
     1.2 +++ b/README	Fri Dec 10 03:44:34 2010 +0200
     1.3 @@ -1,3 +1,43 @@
     1.4 -Code for article 1
     1.5 +Article 1 source code
     1.6 +---------------------
     1.7  Author: John Tsiombikas <nuclear@member.fsf.org>
     1.8 -License: GNU GPL v3 (or later).
     1.9 +
    1.10 +License: GNU GPL v3 or any later version published by the free software
    1.11 +    foundation. See COPYING for details.
    1.12 +
    1.13 +About
    1.14 +-----
    1.15 +This is the supplemental source code for the first part of the introduction to
    1.16 +kernel development articles. It deals with booting up from a multiboot-compliant
    1.17 +boot loader and using the VGA for text output.
    1.18 +
    1.19 +Compiling & Running
    1.20 +-------------------
    1.21 +To compile kernel image (kernel.elf) just type make (or gmake, if your default
    1.22 +make tool is not GNU make). A script called "run" is supplied that will use qemu
    1.23 +to run the kernel in a virtual machine.
    1.24 +
    1.25 +If you wish to boot up the kernel on your computer you need a multiboot
    1.26 +compliant boot loader like GRUB. Since you probably already have GRUB installed
    1.27 +if you're running a GNU/Linux distribution, just add an entry to the GRUB config
    1.28 +file (commonly /boot/grub/menu.lst) similar to this one and reboot:
    1.29 +
    1.30 +title My kernel
    1.31 +root (hdX,Y)  # where X is the disk number and Y the partition (first being 0)
    1.32 +kernel /path/to/kernel_code/kernel.elf    # change this to the actual path
    1.33 +
    1.34 +In case you are using GRUB 2 instead of the original GRUB, you'll have to
    1.35 +consult the documentation on how to modify the above into the GRUB 2 syntax.
    1.36 +
    1.37 +Disclaimer
    1.38 +----------
    1.39 +All programs contain bugs, and this sample code will undoubtedly have its share.
    1.40 +Running buggy kernel code on the real machine is very dangerous and may result
    1.41 +in data loss or even damage to your computer in extreme cases. The author
    1.42 +assumes no responsibility for any such eventuality. Run this code on your
    1.43 +computer at your own risk.
    1.44 +
    1.45 +Contact
    1.46 +-------
    1.47 +For any comments or suggestions regarding the articles or this supplemental
    1.48 +code, please contact me at nuclear@member.fsf.org