annotate README.md @ 187:bf5ab358f43a

Renamed readme and added status badge
author Windel Bouwman
date Sat, 25 May 2013 14:41:19 +0200
parents README@e47bfef80baf
children 1113da536872
rev   line source
187
bf5ab358f43a Renamed readme and added status badge
Windel Bouwman
parents: 43
diff changeset
1
bf5ab358f43a Renamed readme and added status badge
Windel Bouwman
parents: 43
diff changeset
2 Status badge:
bf5ab358f43a Renamed readme and added status badge
Windel Bouwman
parents: 43
diff changeset
3
bf5ab358f43a Renamed readme and added status badge
Windel Bouwman
parents: 43
diff changeset
4 [![Build Status](https://drone.io/bitbucket.org/windel/lcfos/status.png)](https://drone.io/bitbucket.org/windel/lcfos/latest)
bf5ab358f43a Renamed readme and added status badge
Windel Bouwman
parents: 43
diff changeset
5
9
92ace1ca50a8 64 bits kernel without interrupts but with printf in C
windel
parents: 1
diff changeset
6 = Project goals =
92ace1ca50a8 64 bits kernel without interrupts but with printf in C
windel
parents: 1
diff changeset
7 * To write a microkernel sort of OS.
92ace1ca50a8 64 bits kernel without interrupts but with printf in C
windel
parents: 1
diff changeset
8 * Write the kernel in C ('cos')
92ace1ca50a8 64 bits kernel without interrupts but with printf in C
windel
parents: 1
diff changeset
9 * 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
10 * 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
11 * 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
12
92ace1ca50a8 64 bits kernel without interrupts but with printf in C
windel
parents: 1
diff changeset
13 = Directory structure =
92ace1ca50a8 64 bits kernel without interrupts but with printf in C
windel
parents: 1
diff changeset
14 '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
15 '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
16 '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
17
1
92df07bc2081 Initial import of compiler
windel
parents:
diff changeset
18 = Software required =
92df07bc2081 Initial import of compiler
windel
parents:
diff changeset
19 * python3
92df07bc2081 Initial import of compiler
windel
parents:
diff changeset
20 * pyqt4
92df07bc2081 Initial import of compiler
windel
parents:
diff changeset
21 Optional:
92df07bc2081 Initial import of compiler
windel
parents:
diff changeset
22 * bochs
92df07bc2081 Initial import of compiler
windel
parents:
diff changeset
23 * nasm
92df07bc2081 Initial import of compiler
windel
parents:
diff changeset
24
92df07bc2081 Initial import of compiler
windel
parents:
diff changeset
25 = How to start the IDE =
92df07bc2081 Initial import of compiler
windel
parents:
diff changeset
26
92df07bc2081 Initial import of compiler
windel
parents:
diff changeset
27 $ cd ide
92df07bc2081 Initial import of compiler
windel
parents:
diff changeset
28 $ python runide.py
92df07bc2081 Initial import of compiler
windel
parents:
diff changeset
29
41
35cc54e078dd Added memory functions
windel
parents: 9
diff changeset
30 = About the C version of the OS =
35cc54e078dd Added memory functions
windel
parents: 9
diff changeset
31
35cc54e078dd Added memory functions
windel
parents: 9
diff changeset
32 To build the C kernel, enter:
35cc54e078dd Added memory functions
windel
parents: 9
diff changeset
33 $ cd cos
35cc54e078dd Added memory functions
windel
parents: 9
diff changeset
34 $ make
35cc54e078dd Added memory functions
windel
parents: 9
diff changeset
35
35cc54e078dd Added memory functions
windel
parents: 9
diff changeset
36 Running the OS with bochs:
35cc54e078dd Added memory functions
windel
parents: 9
diff changeset
37 $ bochs -q
35cc54e078dd Added memory functions
windel
parents: 9
diff changeset
38
43
e47bfef80baf Fixed build by commenting out initrd code
windel
parents: 41
diff changeset
39 Running the OS with kvm:
e47bfef80baf Fixed build by commenting out initrd code
windel
parents: 41
diff changeset
40 $ kvm -fda bootdisk.img
e47bfef80baf Fixed build by commenting out initrd code
windel
parents: 41
diff changeset
41 or:
e47bfef80baf Fixed build by commenting out initrd code
windel
parents: 41
diff changeset
42 $ qemu-kvm -fda bootdisk.img
e47bfef80baf Fixed build by commenting out initrd code
windel
parents: 41
diff changeset
43
41
35cc54e078dd Added memory functions
windel
parents: 9
diff changeset
44 required tools:
35cc54e078dd Added memory functions
windel
parents: 9
diff changeset
45 - bochs: for simulating the OS
35cc54e078dd Added memory functions
windel
parents: 9
diff changeset
46 - mtools: for copying files to the bootdisk
35cc54e078dd Added memory functions
windel
parents: 9
diff changeset
47 - nasm: for assembler instructions
35cc54e078dd Added memory functions
windel
parents: 9
diff changeset
48 - gcc: for compiling the C sources
35cc54e078dd Added memory functions
windel
parents: 9
diff changeset
49 - make: for building the system
35cc54e078dd Added memory functions
windel
parents: 9
diff changeset
50 - python 3: for building the initial ramdisk
35cc54e078dd Added memory functions
windel
parents: 9
diff changeset
51
35cc54e078dd Added memory functions
windel
parents: 9
diff changeset
52 Enjoy!
35cc54e078dd Added memory functions
windel
parents: 9
diff changeset
53