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
bf5ab358f43a Renamed readme and added status badge
Windel Bouwman
parents: 43
diff changeset
1
273
6b3a874edd6e Added some docs
Windel Bouwman
parents: 257
diff changeset
2 About
6b3a874edd6e Added some docs
Windel Bouwman
parents: 257
diff changeset
3 =====
6b3a874edd6e Added some docs
Windel Bouwman
parents: 257
diff changeset
4
6b3a874edd6e Added some docs
Windel Bouwman
parents: 257
diff changeset
5 Project goals
6b3a874edd6e Added some docs
Windel Bouwman
parents: 257
diff changeset
6 -------------
6b3a874edd6e Added some docs
Windel Bouwman
parents: 257
diff changeset
7
256
225f444019b1 Added build and flash menu option
Windel Bouwman
parents: 213
diff changeset
8 * To write a microkernel OS.
225f444019b1 Added build and flash menu option
Windel Bouwman
parents: 213
diff changeset
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
6b3a874edd6e Added some docs
Windel Bouwman
parents: 257
diff changeset
14 Directory structure
6b3a874edd6e Added some docs
Windel Bouwman
parents: 257
diff changeset
15 -------------------
188
1113da536872 Used markdown
Windel Bouwman
parents: 187
diff changeset
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
6b3a874edd6e Added some docs
Windel Bouwman
parents: 257
diff changeset
21 Software dependencies
6b3a874edd6e Added some docs
Windel Bouwman
parents: 257
diff changeset
22 ---------------------
1
92df07bc2081 Initial import of compiler
windel
parents:
diff changeset
23 * python3
92df07bc2081 Initial import of compiler
windel
parents:
diff changeset
24 * pyqt4
92df07bc2081 Initial import of compiler
windel
parents:
diff changeset
25
273
6b3a874edd6e Added some docs
Windel Bouwman
parents: 257
diff changeset
26 How to start the IDE
6b3a874edd6e Added some docs
Windel Bouwman
parents: 257
diff changeset
27 --------------------
1
92df07bc2081 Initial import of compiler
windel
parents:
diff changeset
28
213
003c8a976fff Merge of semantics and parser again ..
Windel Bouwman
parents: 188
diff changeset
29 cd python
256
225f444019b1 Added build and flash menu option
Windel Bouwman
parents: 213
diff changeset
30 python ide.py
225f444019b1 Added build and flash menu option
Windel Bouwman
parents: 213
diff changeset
31
273
6b3a874edd6e Added some docs
Windel Bouwman
parents: 257
diff changeset
32 Run unittests
6b3a874edd6e Added some docs
Windel Bouwman
parents: 257
diff changeset
33 -------------
256
225f444019b1 Added build and flash menu option
Windel Bouwman
parents: 213
diff changeset
34
257
703321743e8a Fixed readme
Windel Bouwman
parents: 256
diff changeset
35 cd python
703321743e8a Fixed readme
Windel Bouwman
parents: 256
diff changeset
36 python -m unittest
41
35cc54e078dd Added memory functions
windel
parents: 9
diff changeset
37
273
6b3a874edd6e Added some docs
Windel Bouwman
parents: 257
diff changeset
38 .. image:: https://drone.io/bitbucket.org/windel/lcfos/status.png
43
e47bfef80baf Fixed build by commenting out initrd code
windel
parents: 41
diff changeset
39
41
35cc54e078dd Added memory functions
windel
parents: 9
diff changeset
40