From 553657a0b527ae8ce09ac628da6122fbdd57157b Mon Sep 17 00:00:00 2001
From: Tianhao Wang <wth@riseup.net>
Date: Tue, 30 Jan 2024 01:58:30 +0100
Subject: modify readme, add license info

---
 LICENSE    |  1 +
 README     | 57 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 README.txt | 48 ------------------------------------------------
 3 files changed, 58 insertions(+), 48 deletions(-)
 create mode 100644 LICENSE
 create mode 100644 README
 delete mode 100644 README.txt

diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..d5c9ba8
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1 @@
+currently empty
diff --git a/README b/README
new file mode 100644
index 0000000..31c4b53
--- /dev/null
+++ b/README
@@ -0,0 +1,57 @@
+# 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**
+[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
+- 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.
+
diff --git a/README.txt b/README.txt
deleted file mode 100644
index baed4ae..0000000
--- a/README.txt
+++ /dev/null
@@ -1,48 +0,0 @@
-# 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**
-[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
-- 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.
-
-- 
cgit v1.2.3-70-g09d2