add howto

Doxyfile

@@ -736,7 +736,8 @@ WARN_LOGFILE           =
 INPUT                  = ./include \
                          ./kernel \
                          ./arch \
-                         ./libkern 
+                         ./libkern \
+                         ./documentation/text
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses

NOTICE

@@ -1,23 +0,0 @@
-
-   eduOS
-   Copyright 2010-2013, Stefan Lankes, RWTH Aachen University
-
-The learning operating system eduOS is derived from following tutorials
-and software distributions.
-
-=========================================================================
-= bkerndev - Bran's Kernel Development Tutorial                         =
-=========================================================================
-The first steps to realize eduOS based on Bran's Kernel Development 
-Tutorial (http://www.osdever.net/bkerndev/index.php). In particular, the
-initialization of GDT, IDT and the interrupt handlers are derived from
-this tutorial.
-
-=========================================================================
-= kprintf, umoddu3, udivdi3, qdivrem, divdi3, lshrdi3, moddi3, strtol,  =
-= strtoul, ucmpdi2                                                      =
-=========================================================================
-This software contains code derived from material licensed
-to the University of California by American Telephone and Telegraph
-Co. or Unix System Laboratories, Inc. and are reproduced herein with
-the permission of UNIX System Laboratories, Inc.

documentation/text/compilation.dox

@@ -0,0 +1,37 @@
+/**
+ * @file compilation.dox
+ * @page compilation Compiling and Running eduOS
+ *
+ * @section toc Table of Contents
+ * - @ref checkout
+ * - @ref compiling
+ * - @ref runqemu
+ *
+ * @section checkout Checking out eduOS online
+ * 
+ * The eduOS project is hosted in a Git repository. To check it out, just type:
+ *
+ * \verbatim$ git clone https://github.com/stlankes/eduOS.git  \endverbatim
+ *
+ * @section compiling Compiling eduOS
+ *
+ * To compile eduOS, you will need a proper Makefile and configuration. To use the example files, just do the following:
+ *
+ * \verbatim 
+$ cd eduOS
+$ cp Makefile.example Makefile
+$ (cd include/eduos; cp config.h.example config.h) \endverbatim
+ * 
+ * The standard configuration works on usual PC hardware configurations as well as in emulators.
+ *
+ * Compiler settings can be edited in the Makefile, while the kernel configuration can be found in the just copied configuration file.
+ *
+ * @section runqemu Running eduOS in Qemu
+ *
+ * There is a Make-target for running eduOS in Qemu:
+ * \verbatim$ make qemu \endverbatim
+ *
+ * The emulator is then started with the following parameters:
+ * \verbatim$ qemu -monitor stdio -smp 2 -net nic,model=rtl8139 -net user,hostfwd=tcp::12345-:7 -net dump -kernel eduos.elf \endverbatim
+ *
+ */

documentation/text/mainpage.dox

@@ -0,0 +1,25 @@
+/**
+ * @file mainpage.dox
+ * @mainpage 
+ *
+ * @section Introduction
+ *
+ * eduOS is a Unix-like computer operating system based on a monolithic architecture for educational purposes.
+ * It is derived from following tutorials and software distributions.
+ * 
+ * =========================================================================
+ * bkerndev - Bran's Kernel Development Tutorial
+ * =========================================================================
+ * The first steps to realize eduOS based on Bran's Kernel Development 
+ * Tutorial (http://www.osdever.net/tutorials/view/brans-kernel-development-tutorial).
+ * In particular, the initialization of GDT, IDT and the interrupt handlers are derived
+ * from this tutorial.
+ *
+ * =====================================================================================
+ * kprintf, umoddu3, udivdi3, qdivrem, divdi3, lshrdi3, moddi3, strtol, strtoul, ucmpdi2
+ * =====================================================================================
+ * This software contains code derived from material licensed
+ * to the University of California by American Telephone and Telegraph
+ * Co. or Unix System Laboratories, Inc. and are reproduced herein with
+ * the permission of UNIX System Laboratories, Inc.
+ */