aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTianhao Wang <wth@riseup.net>2023-10-26 18:08:51 +0200
committerTianhao Wang <wth@riseup.net>2023-10-26 18:08:51 +0200
commit36466f28480669af3e7a01c1b305f51eca81a738 (patch)
tree51ba9f746b0f45c8687cd7e3781769f274cce122
parentd295be457035b42c4451610c50e520c2fecead54 (diff)
change readme format to txt
-rw-r--r--README.txt (renamed from readme.md)42
1 files changed, 21 insertions, 21 deletions
diff --git a/readme.md b/README.txt
index 6a62078..baed4ae 100644
--- a/readme.md
+++ b/README.txt
@@ -5,30 +5,30 @@ 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**
-[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
-[ ] - Keyboard controller and input handler
-[ ] - Interrupt handler
-[ ] - Timer Interrupt
-[ ] - Threading
-[ ] - Scheduler
-[ ] - Synchronization Primitives
-
-**Dependencies**
+(Operating System Construction), led by my Professor Dr. Horst Schirmeier.
+
+
+**Status**
+[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
+[ ] - Keyboard controller and input handler
+[ ] - Interrupt handler
+[ ] - Timer Interrupt
+[ ] - Threading
+[ ] - Scheduler
+[ ] - Synchronization Primitives
+
+**Dependencies**
- cargo / rustc (nightly)
-- xbuild for crossbuild
+- 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**
+**Before building**
- You may need to add the rust sources component by `rustup component add rust-src`
**How to build**
@@ -37,12 +37,12 @@ Universities. This one in perticular, is based on the TU Dresden version
- use `make qemu` to load and test the iso image with qemu
# Remarks
-**Why not projects like [blog_os](https://os.phil-opp.com/)?**
+**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**
+**Your code sucks**
Yes. I'm a rust beginner.