CeDOS - README.md

README.md (view raw)

# CeDOS

Simple x86 operating system written in assembly and C.

## Software Requirements

* CMake + Ninja
* [GCC Cross Compiler + matching binutils](https://wiki.osdev.org/GCC_Cross-Compiler), tailored for freestanding i686-elf-targets
* Doxygen: If you want to build the documentation
* QEMU: To emulate an x86 system. More specifically, `qemu-system-i386`, available via apt.

Easiest way to get these is to use the nix development shell:

```shell
nix develop
```

## Make commands

### Build

```shell
mkdir -p build/
cd build/
cmake -GNinja ..
ninja
```

The image is put into `build/images/cedos.img` and can be flashed onto a
bootable storage device or run in QEMU.

### Run (in QEMU)

```shell
./run.sh build/images/cedos.img
```

### Clear output directories

```shell
cd build/
ninja clean
```

### Run tests

```shell
cd build/
../test.sh
```