Mercurial > lcfOS
diff readme.rst @ 273:6b3a874edd6e
Added some docs
author | Windel Bouwman |
---|---|
date | Mon, 02 Sep 2013 17:40:21 +0200 |
parents | README.md@703321743e8a |
children | c137f1fe3e65 |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/readme.rst Mon Sep 02 17:40:21 2013 +0200 @@ -0,0 +1,40 @@ + +About +===== + +Project goals +------------- + +* To write a microkernel OS. +* Write the kernel in C3 ('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 dependencies +--------------------- + * python3 + * pyqt4 + +How to start the IDE +-------------------- + + cd python + python ide.py + +Run unittests +------------- + + cd python + python -m unittest + +.. image:: https://drone.io/bitbucket.org/windel/lcfos/status.png + +