Mercurial > lcfOS

annotate readme.rst @ 409:8fe299cd2d55 devel

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Close devel branch
author Windel Bouwman
date Sat, 21 Feb 2015 12:20:10 +0100
parents 87feb8a23b4d
children 899ae3aea803
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
300
Windel Bouwman
parents: 299
diff changeset
21 * python3.3
332
87feb8a23b4d Added task list command
Windel Bouwman
parents: 318
diff changeset
22 * pyyaml for yaml module
283
c9781c73e7e2 Added first kernel files
Windel Bouwman
parents: 282
diff changeset
23 * (optional) pyqt5, pyqt4 or pyside
1
92df07bc2081 Initial import of compiler
windel
parents:
diff changeset
24
273
6b3a874edd6e Added some docs
Windel Bouwman
parents: 257
diff changeset
25 How to start the IDE
6b3a874edd6e Added some docs
Windel Bouwman
parents: 257
diff changeset
26 --------------------
1
92df07bc2081 Initial import of compiler
windel
parents:
diff changeset
27
290
7b38782ed496 File moves
Windel Bouwman
parents: 283
diff changeset
28 .. code:: bash
7b38782ed496 File moves
Windel Bouwman
parents: 283
diff changeset
29
213
003c8a976fff Merge of semantics and parser again ..
Windel Bouwman
parents: 188
diff changeset
30 cd python
256
225f444019b1 Added build and flash menu option
Windel Bouwman
parents: 213
diff changeset
31 python ide.py
225f444019b1 Added build and flash menu option
Windel Bouwman
parents: 213
diff changeset
32
298
f7c3d38d0a47 Added reference to read the docs
Windel Bouwman
parents: 290
diff changeset
33
318
e84047f29c78 Add burg and yacc initial attempts
Windel Bouwman
parents: 300
diff changeset
34 Source code
e84047f29c78 Add burg and yacc initial attempts
Windel Bouwman
parents: 300
diff changeset
35 -----------
e84047f29c78 Add burg and yacc initial attempts
Windel Bouwman
parents: 300
diff changeset
36
e84047f29c78 Add burg and yacc initial attempts
Windel Bouwman
parents: 300
diff changeset
37 Sources are located here:
e84047f29c78 Add burg and yacc initial attempts
Windel Bouwman
parents: 300
diff changeset
38 https://bitbucket.org/windel/lcfos
e84047f29c78 Add burg and yacc initial attempts
Windel Bouwman
parents: 300
diff changeset
39
e84047f29c78 Add burg and yacc initial attempts
Windel Bouwman
parents: 300
diff changeset
40
298
f7c3d38d0a47 Added reference to read the docs
Windel Bouwman
parents: 290
diff changeset
41 Docs
f7c3d38d0a47 Added reference to read the docs
Windel Bouwman
parents: 290
diff changeset
42 ----
f7c3d38d0a47 Added reference to read the docs
Windel Bouwman
parents: 290
diff changeset
43
300
Windel Bouwman
parents: 299
diff changeset
44 Docs are located here:
298
f7c3d38d0a47 Added reference to read the docs
Windel Bouwman
parents: 290
diff changeset
45 http://lcfos.readthedocs.org/en/latest/
f7c3d38d0a47 Added reference to read the docs
Windel Bouwman
parents: 290
diff changeset
46
273
6b3a874edd6e Added some docs
Windel Bouwman
parents: 257
diff changeset
47 Run unittests
6b3a874edd6e Added some docs
Windel Bouwman
parents: 257
diff changeset
48 -------------
256
225f444019b1 Added build and flash menu option
Windel Bouwman
parents: 213
diff changeset
49
290
7b38782ed496 File moves
Windel Bouwman
parents: 283
diff changeset
50 .. code:: bash
7b38782ed496 File moves
Windel Bouwman
parents: 283
diff changeset
51
7b38782ed496 File moves
Windel Bouwman
parents: 283
diff changeset
52 cd test
300
Windel Bouwman
parents: 299
diff changeset
53 ./runtests.sh
41
35cc54e078dd Added memory functions
windel
parents: 9
diff changeset
54
290
7b38782ed496 File moves
Windel Bouwman
parents: 283
diff changeset
55
298
f7c3d38d0a47 Added reference to read the docs
Windel Bouwman
parents: 290
diff changeset
56 Status
f7c3d38d0a47 Added reference to read the docs
Windel Bouwman
parents: 290
diff changeset
57 ------
f7c3d38d0a47 Added reference to read the docs
Windel Bouwman
parents: 290
diff changeset
58
300
Windel Bouwman
parents: 299
diff changeset
59 The project is contains tests which are run continuously at drone.io.
Windel Bouwman
parents: 299
diff changeset
60
273
6b3a874edd6e Added some docs
Windel Bouwman
parents: 257
diff changeset
61 .. image:: https://drone.io/bitbucket.org/windel/lcfos/status.png
283
c9781c73e7e2 Added first kernel files
Windel Bouwman
parents: 282
diff changeset
62
290
7b38782ed496 File moves
Windel Bouwman
parents: 283
diff changeset
63 .. 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
64
41
35cc54e078dd Added memory functions
windel
parents: 9
diff changeset
65
299
674789d9ff37 Added a doc
Windel Bouwman
parents: 298
diff changeset
66 https://drone.io/bitbucket.org/windel/lcfos
282
c137f1fe3e65 Add codeship hook
Windel Bouwman
parents: 273
diff changeset
67
299
674789d9ff37 Added a doc
Windel Bouwman
parents: 298
diff changeset
68