Skip to content

Commit ae73b20

Browse files
committed
Updated README
1 parent 49b8891 commit ae73b20

1 file changed

Lines changed: 31 additions & 3 deletions

File tree

README.md

Lines changed: 31 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,33 @@
1-
# Custom OS
1+
# CustomOS
2+
3+
Developing my own 32-bit x86 (IA32) based operating system written in C++.
4+
5+
Used some of the code from the OSDev Wiki: https://wiki.osdev.org/
6+
7+
## Installation
8+
9+
### Dependencies
10+
11+
#### Essential:
12+
13+
- [make](https://www.gnu.org/software/make/)
14+
- Host OS: Linux. Development has been done on [Windows Subsytem for Linux](https://docs.microsoft.com/en-us/windows/wsl/install-win10) on Windows 10 (Ubuntu 20.04.2 LTS). Or you can develop on Ubuntu or another Debian based OS.
15+
- GCC cross compiler for ```i686-elf``` targets. Read [this tutorial](https://wiki.osdev.org/GCC_Cross-Compiler) for more info on how to do this.
16+
17+
#### Optional:
18+
19+
- Install [qemu](https://www.qemu.org/). Required for booting and testing the OS in a VM locally.
20+
21+
22+
## Compiling customOS
23+
24+
Open a terminal and run:
25+
- ```make install```
26+
27+
28+
## Running customOS
29+
30+
You can run customOS locally (requires ```qemu```).
31+
- ```make run```
232

3-
Developing my own operating system written in C++.
433

5-
Used some of the code from the OSDev Wiki: https://wiki.osdev.org/

0 commit comments

Comments
 (0)