Mercurial > lcfOS

annotate readme.rst @ 376:1e951e71d3f1

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Change to readme
author Windel Bouwman
date Tue, 25 Mar 2014 19:36:51 +0100
parents 899ae3aea803
children 9667d78ba79e
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
376
1e951e71d3f1 Change to readme
Windel Bouwman
parents: 352
diff changeset
18
1e951e71d3f1 Change to readme
Windel Bouwman
parents: 352
diff changeset
19 How to run this?
1e951e71d3f1 Change to readme
Windel Bouwman
parents: 352
diff changeset
20 ----------------
1e951e71d3f1 Change to readme
Windel Bouwman
parents: 352
diff changeset
21
1e951e71d3f1 Change to readme
Windel Bouwman
parents: 352
diff changeset
22 Install required software:
283
c9781c73e7e2 Added first kernel files
Windel Bouwman
parents: 282
diff changeset
23
300
Windel Bouwman
parents: 299
diff changeset
24 * python3.3
332
87feb8a23b4d Added task list command
Windel Bouwman
parents: 318
diff changeset
25 * pyyaml for yaml module
283
c9781c73e7e2 Added first kernel files
Windel Bouwman
parents: 282
diff changeset
26 * (optional) pyqt5, pyqt4 or pyside
1
92df07bc2081 Initial import of compiler
windel
parents:
diff changeset
27
376
1e951e71d3f1 Change to readme
Windel Bouwman
parents: 352
diff changeset
28 Checkout the code:
1
92df07bc2081 Initial import of compiler
windel
parents:
diff changeset
29
290
7b38782ed496 File moves
Windel Bouwman
parents: 283
diff changeset
30 .. code:: bash
7b38782ed496 File moves
Windel Bouwman
parents: 283
diff changeset
31
376
1e951e71d3f1 Change to readme
Windel Bouwman
parents: 352
diff changeset
32 hg clone https://bitbucket.org/windel/lcfos
1e951e71d3f1 Change to readme
Windel Bouwman
parents: 352
diff changeset
33 cd lcfos
1e951e71d3f1 Change to readme
Windel Bouwman
parents: 352
diff changeset
34
1e951e71d3f1 Change to readme
Windel Bouwman
parents: 352
diff changeset
35 Run some unit tests:
1e951e71d3f1 Change to readme
Windel Bouwman
parents: 352
diff changeset
36
1e951e71d3f1 Change to readme
Windel Bouwman
parents: 352
diff changeset
37 .. code:: bash
1e951e71d3f1 Change to readme
Windel Bouwman
parents: 352
diff changeset
38
1e951e71d3f1 Change to readme
Windel Bouwman
parents: 352
diff changeset
39 cd test
1e951e71d3f1 Change to readme
Windel Bouwman
parents: 352
diff changeset
40 python3 run_tests.py
256
225f444019b1 Added build and flash menu option
Windel Bouwman
parents: 213
diff changeset
41
298
f7c3d38d0a47 Added reference to read the docs
Windel Bouwman
parents: 290
diff changeset
42
376
1e951e71d3f1 Change to readme
Windel Bouwman
parents: 352
diff changeset
43 Weblinks
1e951e71d3f1 Change to readme
Windel Bouwman
parents: 352
diff changeset
44 --------
1e951e71d3f1 Change to readme
Windel Bouwman
parents: 352
diff changeset
45
1e951e71d3f1 Change to readme
Windel Bouwman
parents: 352
diff changeset
46 Docs are located here:
1e951e71d3f1 Change to readme
Windel Bouwman
parents: 352
diff changeset
47 http://lcfos.readthedocs.org/en/latest/
318
e84047f29c78 Add burg and yacc initial attempts
Windel Bouwman
parents: 300
diff changeset
48
e84047f29c78 Add burg and yacc initial attempts
Windel Bouwman
parents: 300
diff changeset
49 Sources are located here:
e84047f29c78 Add burg and yacc initial attempts
Windel Bouwman
parents: 300
diff changeset
50 https://bitbucket.org/windel/lcfos
e84047f29c78 Add burg and yacc initial attempts
Windel Bouwman
parents: 300
diff changeset
51
376
1e951e71d3f1 Change to readme
Windel Bouwman
parents: 352
diff changeset
52 here:
1e951e71d3f1 Change to readme
Windel Bouwman
parents: 352
diff changeset
53 http://hg.assembla.com/lcfOS/
298
f7c3d38d0a47 Added reference to read the docs
Windel Bouwman
parents: 290
diff changeset
54
376
1e951e71d3f1 Change to readme
Windel Bouwman
parents: 352
diff changeset
55 and here:
1e951e71d3f1 Change to readme
Windel Bouwman
parents: 352
diff changeset
56 https://pikacode.com/windel/lcfos/
290
7b38782ed496 File moves
Windel Bouwman
parents: 283
diff changeset
57
298
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
352
899ae3aea803 First kernel run for vexpressA9
Windel Bouwman
parents: 332
diff changeset
63 https://drone.io/bitbucket.org/windel/lcfos
899ae3aea803 First kernel run for vexpressA9
Windel Bouwman
parents: 332
diff changeset
64
899ae3aea803 First kernel run for vexpressA9
Windel Bouwman
parents: 332
diff changeset
65 Repository metrics:
899ae3aea803 First kernel run for vexpressA9
Windel Bouwman
parents: 332
diff changeset
66
290
7b38782ed496 File moves
Windel Bouwman
parents: 283
diff changeset
67 .. 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
68
352
899ae3aea803 First kernel run for vexpressA9
Windel Bouwman
parents: 332
diff changeset
69 http://www.ohloh.net/p/lcfos
899ae3aea803 First kernel run for vexpressA9
Windel Bouwman
parents: 332
diff changeset
70
41
35cc54e078dd Added memory functions
windel
parents: 9
diff changeset
71