init

README.md

@@ -0,0 +1,35 @@
+# Nub OS
+
+## Dependencies
+
+### Building the kernel
+
+- `grub`
+- `mtools`
+- `make`
+- `x86_64-elf-gcc`
+- `x86_64-elf-ld`
+- `nasm`
+
+## Building
+
+### Disk image
+
+```sh
+make iso
+```
+
+## Running
+
+After building the iso, run the following:
+
+```sh
+qemu-system-x86_64 -cdrom .build/nub-os.iso
+```
+
+## Debugging
+
+```sh
+qemu-system-x86_64 -s -S -cdrom .build/nub-os.iso
+gdb -tui .build/kernel/kernel -ex "target remote localhost:1234"
+```