rename README

1 files changed, 85 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..80235f8
--- /dev/null
+++ b/README.md
@@ -0,0 +1,85 @@
+[![builds.sr.ht status](https://builds.sr.ht/~shrik3.svg)](https://builds.sr.ht/~shrik3?search=)
+
+# License & Copyright:
+
+This project aims for a total rewrite TU Dresden OS Group's tutorial OS
+"OOStuBS". However this is in its very early stage and is using some
+boilerplates from the lecture e.g. the startup assembly code.
+
+This project will adapt GPL when the dependencies are sorted out (hopefully very
+soon). Untill then all rights are reserverd.
+
+# The rust port of OOStuBS [WIP]
+
+This is a toy bare metal operation system implemented in Rust. Apologies for my
+shitty code, I'm a rust beginner.
+
+The project is based on the OOStuBS, an OS exercise project used in some German
+Universities. This one in perticular, is based on the TU Dresden version
+(Operating System Construction), led by my Professor Dr. Horst Schirmeier.
+
+**Status / Roadmap**
+[X] - Basic code structure  
+[X] - Build minimal iso image  
+[X] - bootable using grub  
+[X] - Setting up CGA display, print something (hello world)  
+[X] - Provide "printf" support  
+[X] - Intigrate print into rust println! etc.
+[.] - asm! Wrappers for basic instructions
+[.] - Keyboard controller and input handler  
+[.] - Interrupt handler  
+[ ] - Timer Interrupt  
+[ ] - Threading  
+[ ] - Scheduler (single CPU)
+[ ] - Synchronization Primitives  
+
+Beyond the original StuBS
+[ ] - Task Descriptor structures
+[ ] - Paging: PMA and paging structures
+[ ] - Paging: pagefault handler
+[ ] - user heap and mmap
+[ ] - Upperhalf Kernel
+[ ] - Address Space for each Process
+[ ] - in memory FS
+[ ] - user library
+[ ] - syscall
+[ ] - aarch64 support
+
+**Dependencies**
+- cargo / rustc (nightly)
+- xbuild for crossbuild
+- basics: nasm, make, glibc, ld etc.
+- xorriso and grub (to create bootable image)
+- qemu-system-x86_64 (optionly for simulation)
+
+**Before building**
+- You may need to add the rust sources component by `rustup component add  rust-src`
+
+**How to build**
+- simply run `make`, you will get `bootdisk.iso`, which you can use to boot a
+  bare metal
+- use `make qemu` to load and test the iso image with qemu
+
+# Remarks
+**Why not projects like [blog_os](https://os.phil-opp.com/)?**
+firstly, because it's my own practice. "What I can't create, I don't understand".
+Secondly, the newest revision of *blog_os* can only be booted with BIOS, not
+UEFI. And the complexity (e.g. the sartup.s) is hidden behind the `bootimage`,
+I feel necessary to go through the painful part.
+
+**Your code sucks**
+Yes. I'm a rust beginner.
+
+**Helper docs**
+
+x86_64 calling conventions  
+https://aaronbloomfield.github.io/pdr/book/x86-64bit-ccc-chapter.pdf
+
+Rust inline asm  
+https://rust-lang.github.io/rfcs/2873-inline-asm.html
+
+asm Syntax : (we use nasm in assembly and .intel_syntax noprefix in rust asm)  
+https://en.wikipedia.org/wiki/X86_assembly_language#Syntax
+
+naming conventions  
+https://rust-lang.github.io/api-guidelines/naming.html