Mercurial > lcfOS
annotate 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 |
rev | line source |
---|---|
187 | 1 |
273 | 2 About |
3 ===== | |
4 | |
5 Project goals | |
6 ------------- | |
7 | |
256 | 8 * To write a microkernel OS. |
9 * Write the kernel in C3 ('cos') | |
9
92ace1ca50a8
64 bits kernel without interrupts but with printf in C
windel
parents:
1
diff
changeset
|
10 * Write a kernel in oberon like language and be able to compile this with the ide. |
92ace1ca50a8
64 bits kernel without interrupts but with printf in C
windel
parents:
1
diff
changeset
|
11 * Create python scripts that form the major part of the OS. |
92ace1ca50a8
64 bits kernel without interrupts but with printf in C
windel
parents:
1
diff
changeset
|
12 * Make IDE in python that can compile the OS. |
92ace1ca50a8
64 bits kernel without interrupts but with printf in C
windel
parents:
1
diff
changeset
|
13 |
273 | 14 Directory structure |
15 ------------------- | |
188 | 16 |
9
92ace1ca50a8
64 bits kernel without interrupts but with printf in C
windel
parents:
1
diff
changeset
|
17 'os' contains the os written in oberon like language. |
92ace1ca50a8
64 bits kernel without interrupts but with printf in C
windel
parents:
1
diff
changeset
|
18 'ide' contains the python3 qt4 ide to build the os. |
92ace1ca50a8
64 bits kernel without interrupts but with printf in C
windel
parents:
1
diff
changeset
|
19 'cos' contains the os written in C and assembler. |
92ace1ca50a8
64 bits kernel without interrupts but with printf in C
windel
parents:
1
diff
changeset
|
20 |
273 | 21 Software dependencies |
22 --------------------- | |
1 | 23 * python3 |
24 * pyqt4 | |
25 | |
273 | 26 How to start the IDE |
27 -------------------- | |
1 | 28 |
213 | 29 cd python |
256 | 30 python ide.py |
31 | |
273 | 32 Run unittests |
33 ------------- | |
256 | 34 |
257 | 35 cd python |
36 python -m unittest | |
41 | 37 |
273 | 38 .. image:: https://drone.io/bitbucket.org/windel/lcfos/status.png |
43 | 39 |
41 | 40 |