--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README.md	Sat May 25 14:41:19 2013 +0200
@@ -0,0 +1,53 @@
+
+Status badge:
+
+[![Build Status](https://drone.io/bitbucket.org/windel/lcfos/status.png)](https://drone.io/bitbucket.org/windel/lcfos/latest)
+
+= Project goals =
+* To write a microkernel sort of OS.
+* Write the kernel in C ('cos')
+* Write a kernel in oberon like language and be able to compile this with the ide.
+* Create python scripts that form the major part of the OS.
+* Make IDE in python that can compile the OS.
+
+= Directory structure =
+'os' contains the os written in oberon like language.
+'ide' contains the python3 qt4 ide to build the os.
+'cos' contains the os written in C and assembler.
+
+= Software required =
+  * python3
+  * pyqt4
+Optional:
+  * bochs
+  * nasm
+
+= How to start the IDE =
+
+$ cd ide
+$ python runide.py
+
+= About the C version of the OS =
+
+To build the C kernel, enter:
+$ cd cos
+$ make
+
+Running the OS with bochs:
+$ bochs -q
+
+Running the OS with kvm:
+$ kvm -fda bootdisk.img
+or:
+$ qemu-kvm -fda bootdisk.img
+
+required tools:
+- bochs: for simulating the OS
+- mtools: for copying files to the bootdisk
+- nasm: for assembler instructions
+- gcc: for compiling the C sources
+- make: for building the system
+- python 3: for building the initial ramdisk
+
+Enjoy!
+