Mercurial > lcfOS

annotate readme.rst @ 299:674789d9ff37

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Added a doc
author Windel Bouwman
date Sun, 01 Dec 2013 18:37:23 +0100
parents f7c3d38d0a47
children 158068af716c
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
283
c9781c73e7e2 Added first kernel files
Windel Bouwman
parents: 282
diff changeset
8 * To write a microkernel based OS
c9781c73e7e2 Added first kernel files
Windel Bouwman
parents: 282
diff changeset
9 * Write the kernel in the c3 language
c9781c73e7e2 Added first kernel files
Windel Bouwman
parents: 282
diff changeset
10 * Create a c3 compiler in python
9
92ace1ca50a8 64 bits kernel without interrupts but with printf in C
windel
parents: 1
diff changeset
11
273
6b3a874edd6e Added some docs
Windel Bouwman
parents: 257
diff changeset
12 Directory structure
6b3a874edd6e Added some docs
Windel Bouwman
parents: 257
diff changeset
13 -------------------
188
1113da536872 Used markdown
Windel Bouwman
parents: 187
diff changeset
14
283
c9781c73e7e2 Added first kernel files
Windel Bouwman
parents: 282
diff changeset
15 'kernel' contains the microkernel.
c9781c73e7e2 Added first kernel files
Windel Bouwman
parents: 282
diff changeset
16 'python' contains the python utilities.
9
92ace1ca50a8 64 bits kernel without interrupts but with printf in C
windel
parents: 1
diff changeset
17
273
6b3a874edd6e Added some docs
Windel Bouwman
parents: 257
diff changeset
18 Software dependencies
6b3a874edd6e Added some docs
Windel Bouwman
parents: 257
diff changeset
19 ---------------------
283
c9781c73e7e2 Added first kernel files
Windel Bouwman
parents: 282
diff changeset
20
c9781c73e7e2 Added first kernel files
Windel Bouwman
parents: 282
diff changeset
21 * python3
c9781c73e7e2 Added first kernel files
Windel Bouwman
parents: 282
diff changeset
22 * (optional) pyqt5, pyqt4 or pyside
1
92df07bc2081 Initial import of compiler
windel
parents:
diff changeset
23
273
6b3a874edd6e Added some docs
Windel Bouwman
parents: 257
diff changeset
24 How to start the IDE
6b3a874edd6e Added some docs
Windel Bouwman
parents: 257
diff changeset
25 --------------------
1
92df07bc2081 Initial import of compiler
windel
parents:
diff changeset
26
290
7b38782ed496 File moves
Windel Bouwman
parents: 283
diff changeset
27 .. code:: bash
7b38782ed496 File moves
Windel Bouwman
parents: 283
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
298
f7c3d38d0a47 Added reference to read the docs
Windel Bouwman
parents: 290
diff changeset
32
f7c3d38d0a47 Added reference to read the docs
Windel Bouwman
parents: 290
diff changeset
33 Docs
f7c3d38d0a47 Added reference to read the docs
Windel Bouwman
parents: 290
diff changeset
34 ----
f7c3d38d0a47 Added reference to read the docs
Windel Bouwman
parents: 290
diff changeset
35
f7c3d38d0a47 Added reference to read the docs
Windel Bouwman
parents: 290
diff changeset
36 Docs are here:
f7c3d38d0a47 Added reference to read the docs
Windel Bouwman
parents: 290
diff changeset
37 http://lcfos.readthedocs.org/en/latest/
f7c3d38d0a47 Added reference to read the docs
Windel Bouwman
parents: 290
diff changeset
38
273
6b3a874edd6e Added some docs
Windel Bouwman
parents: 257
diff changeset
39 Run unittests
6b3a874edd6e Added some docs
Windel Bouwman
parents: 257
diff changeset
40 -------------
256
225f444019b1 Added build and flash menu option
Windel Bouwman
parents: 213
diff changeset
41
290
7b38782ed496 File moves
Windel Bouwman
parents: 283
diff changeset
42 .. code:: bash
7b38782ed496 File moves
Windel Bouwman
parents: 283
diff changeset
43
7b38782ed496 File moves
Windel Bouwman
parents: 283
diff changeset
44 cd test
257
703321743e8a Fixed readme
Windel Bouwman
parents: 256
diff changeset
45 python -m unittest
41
35cc54e078dd Added memory functions
windel
parents: 9
diff changeset
46
290
7b38782ed496 File moves
Windel Bouwman
parents: 283
diff changeset
47
298
f7c3d38d0a47 Added reference to read the docs
Windel Bouwman
parents: 290
diff changeset
48 Status
f7c3d38d0a47 Added reference to read the docs
Windel Bouwman
parents: 290
diff changeset
49 ------
f7c3d38d0a47 Added reference to read the docs
Windel Bouwman
parents: 290
diff changeset
50
273
6b3a874edd6e Added some docs
Windel Bouwman
parents: 257
diff changeset
51 .. image:: https://drone.io/bitbucket.org/windel/lcfos/status.png
283
c9781c73e7e2 Added first kernel files
Windel Bouwman
parents: 282
diff changeset
52
290
7b38782ed496 File moves
Windel Bouwman
parents: 283
diff changeset
53 .. image:: https://www.ohloh.net/p/lcfos/widgets/project_thin_badge.gif
43
e47bfef80baf Fixed build by commenting out initrd code
windel
parents: 41
diff changeset
54
41
35cc54e078dd Added memory functions
windel
parents: 9
diff changeset
55
299
674789d9ff37 Added a doc
Windel Bouwman
parents: 298
diff changeset
56 https://drone.io/bitbucket.org/windel/lcfos
282
c137f1fe3e65 Add codeship hook
Windel Bouwman
parents: 273
diff changeset
57
299
674789d9ff37 Added a doc
Windel Bouwman
parents: 298
diff changeset
58