diff --git a/README.md b/README.md new file mode 100644 index 00000000..aa11dfcf --- /dev/null +++ b/README.md @@ -0,0 +1,35 @@ +# Astral + +Astral is a 64 bit operating system with its own kernel written in C for the x86-64 architecture. + +## Features + +- SMP capable preemptible kernel +- Networking (UDP, DHCP) +- POSIX compatibility +- Ports: mlibc, gcc, bash, doomgeneric, vim, nano and more +- Filesystems: tmpfs, devfs, ext2 +- Block devices: NVMe, virtio-block +- Network devices: virtio-net + +## Current Goals + +- Unix sockets +- TCP +- X.org port +- PS/2 mouse driver +- Quake + +## Building + +The build process only needs xorriso and curl on the host. All other needed packages will be installed/built on the container. + +To build the project, run ``make``. This will create a file named ``astral.iso`` + +## Testing + +There are a few targets in the makefile to run Astral with qemu: + +``make run`` + +``make run-kvm``