Add README

2026-10-27 12:48:22 +00:00 · 2022-07-27 22:42:46 -03:00
parent c4a9e3a3fe
commit d10874a0bc
1 changed files with 16 additions and 0 deletions
@@ -0,0 +1,16 @@
+# Astral
+Astral is a 64 bit operating system for the x86-64 architecture written in C.
+
+It's early in its development and is not production ready.
+
+## Building
+
+You will need an x86-64-elf-gcc cross compiler and nasm.
+
+To build the kernel run ``make``
+To build the iso run ``make sysdisk.iso``
+
+## Testing
+
+There is a make target to run Astral under qemu with kvm. Run ``make test``
+