Mercurial > lcfOS

annotate README.md @ 188:1113da536872

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