Kernel - Cleaning up messages

[tpg/acess2.git] / README

diff --git a/README b/README
index 66d70f1..5680779 100644 (file)
--- a/README
+++ b/README
@@ -4,7 +4,7 @@
 
 Acess2 is [TPG]'s hobby operating system.
 
-The Acess kernel is SEMI-posix compilant, but will be a comatability
+The Acess kernel is SEMI-posix compilant, but there will be a comatability
 library that emulates the different functions.
 
 === Source Tree ===
@@ -29,3 +29,26 @@ The /Kernel tree contains the kernel sources.
  /Usermode/include - Required include files for the shared libraries.
 
 === Building ===
+Required Tools: GNU Toolchain (GCC,Gas,binutils), NASM, mtools, GNU calc
+Compiling Acess is relatively simple (at the moment)
+First edit /Makefile.cfg and set the build programs (making sure they match
+  the architecture you are building for).
+Then select the architecture to build (At the moment only x86:i386 works).
+Edit the FILESYSTEMS variable to alter what filesystems are comipled in 
+  (see /Kernel/vfs/fs for what filesystems are included).
+DRIVERS defines what device drivers are to be included from the Kernel
+  tree (see /Kernel/drv for a list).
+MODULES defines what modules should be statically linked with the kernel
+  (see /Modules for a list)
+
+Set the source root directory (ACESSDIR) and the destination  directory
+ (DISTROOT).
+To be able to build usermode programs, Usermode/Libraries/acess.ld needs
+ to be edited to change the SEARCH_DIR directive to the correct path.
+You may also want to edit Usermode/Filesystem/Conf/BootConf.cfg before
+ installing.
+
+Now you can compile the kernel and usermode applications by calling make
+ in the source root.
+
+