summaryrefslogtreecommitdiff
path: root/readme.txt
diff options
context:
space:
mode:
Diffstat (limited to 'readme.txt')
-rw-r--r--readme.txt6
1 files changed, 6 insertions, 0 deletions
diff --git a/readme.txt b/readme.txt
new file mode 100644
index 0000000..7f4a2e2
--- /dev/null
+++ b/readme.txt
@@ -0,0 +1,6 @@
+mercury is a 64-bit hobby operating system. to build and test it, you will need
+some dependencies. these can be installed on debian with:
+ apt install g++ gcc gdb git make nasm qemu-system-x86 xorriso
+then, just run "make -jx", replacing x with the number of threads to use while
+building. this will create a bios-bootable disk image in out/disk.iso. you can
+then test it in qemu with gdb attached by running "make run".