comparison 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
comparison
equal deleted inserted replaced
186:46d62dadd61b 187:bf5ab358f43a
1
2 Status badge:
3
4 [![Build Status](https://drone.io/bitbucket.org/windel/lcfos/status.png)](https://drone.io/bitbucket.org/windel/lcfos/latest)
5
6 = Project goals =
7 * To write a microkernel sort of OS.
8 * Write the kernel in C ('cos')
9 * Write a kernel in oberon like language and be able to compile this with the ide.
10 * Create python scripts that form the major part of the OS.
11 * Make IDE in python that can compile the OS.
12
13 = Directory structure =
14 'os' contains the os written in oberon like language.
15 'ide' contains the python3 qt4 ide to build the os.
16 'cos' contains the os written in C and assembler.
17
18 = Software required =
19 * python3
20 * pyqt4
21 Optional:
22 * bochs
23 * nasm
24
25 = How to start the IDE =
26
27 $ cd ide
28 $ python runide.py
29
30 = About the C version of the OS =
31
32 To build the C kernel, enter:
33 $ cd cos
34 $ make
35
36 Running the OS with bochs:
37 $ bochs -q
38
39 Running the OS with kvm:
40 $ kvm -fda bootdisk.img
41 or:
42 $ qemu-kvm -fda bootdisk.img
43
44 required tools:
45 - bochs: for simulating the OS
46 - mtools: for copying files to the bootdisk
47 - nasm: for assembler instructions
48 - gcc: for compiling the C sources
49 - make: for building the system
50 - python 3: for building the initial ramdisk
51
52 Enjoy!
53