From 2bbd40acf6cfad741931ee401157b009cbe843cf Mon Sep 17 00:00:00 2001 From: Robbe Van Herck Date: Thu, 9 Jan 2020 12:21:21 +0100 Subject: [PATCH] More info in README.md --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.md b/README.md index c87c33b..8999104 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,17 @@ My attempt at making a bootloader and kernel. +## How to use + +To compile, you need: + +- `i686-elf-gcc` for cross-compiling the kernel +- A system `gcc` for compiling the host-helpers +- `nasm` for compiling the bootloader +- `qemu-system-i386` for emulating (`qemu-system-x86_64` will probably work too, but that is not directly supported) + +If you run `make bin`, it will generate `target/boot.bin`, this is a binary file layed out as described in [the docs](docs/bootloader.md). To burn it on a USB drive, simply `dd if=target/boot.bin of=/dev/sdb` and the drive is bootable and contains an SFS filesystem with the files in `filesystem/`. + ## Bootloader The bootloader is self-written, based on articles on [the OSDev wiki](https://wiki.osdev.org/). It's a single stage, ELF-loading bootloader in the most basic way possible. @@ -19,6 +30,12 @@ The kernel is based on [the bare bones kernel from the OSDev wiki](https://wiki. - [x] Interrupt handling - [x] Keyboard input - [ ] Filesystem interaction + - [ ] Show files in directory + - [ ] Read files in directory + - [ ] Write files in directory +- [ ] Exception handling +- [ ] Tests +- [ ] Running executables from filesystem - [ ] Better memory management As a test, I've implemented day 1 of [advent of code](https://adventofcode.com/) on the [AoC branch](https://github.com/Robbe7730/RoBoot/tree/AoC).