From 3ad3625527eef4032191125ad147690fb00d06eb Mon Sep 17 00:00:00 2001
From: MeexReay <meexreay@gmail.com>
Date: Tue, 28 Jan 2025 00:22:36 +0300
Subject: [PATCH] readme and license and makefile

---
 LICENSE   | 13 +++++++++++++
 Makefile  |  2 +-
 README.md | 31 ++++++++++++++++++++++++-------
 3 files changed, 38 insertions(+), 8 deletions(-)
 create mode 100644 LICENSE

diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..00c3041
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,13 @@
+           DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
+                   Version 2, December 2004
+ 
+Copyright (C) 2004 Sam Hocevar <sam@hocevar.net>
+
+Everyone is permitted to copy and distribute verbatim or modified
+copies of this license document, and changing it is allowed as long
+as the name is changed.
+ 
+           DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
+  TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+ 0. You just DO WHAT THE FUCK YOU WANT TO.
\ No newline at end of file
diff --git a/Makefile b/Makefile
index 0d9fae9..e9c76bb 100644
--- a/Makefile
+++ b/Makefile
@@ -30,7 +30,7 @@ clean:
 	rm -rf kernel/Cargo.lock
 	mkdir target
 
-run-elf: target/kernel.elf
+run-kernel: target/kernel.elf
 	qemu-system-i386 -kernel '$<'
 
 run: target/main.iso
diff --git a/README.md b/README.md
index 1188b78..821173f 100644
--- a/README.md
+++ b/README.md
@@ -2,14 +2,31 @@
 
 Mixray's small OS
 
-## How to build
+## How to use
 
-```
-make build
+```bash
+make clean      # removes target/, kernel/target/, kernel/Cargo.lock
+make build      # builds iso image
+make run        # run iso image
+make run-kernel # run kernel
 ```
 
-## How to run
+## Roadmap
 
-```
-make run
-```
\ No newline at end of file
+<ul><li>- [x] </li></ul> Hello World
+
+### Resources
+
+Internet resources where I found most information about OS dev
+
+- https://github.com/cirosantilli/x86-bare-metal-examples/tree/master/multiboot/hello-world
+- http://wiki.osdev.org/Bare_Bones
+- https://gitea.bedohswe.eu.org/bedohswe/bootsector_tictactoe/
+
+
+### Contributing
+
+If you would like to contribute to the project, feel free to fork the repository and submit a pull request.
+
+### License
+This project is licensed under the WTFPL License
\ No newline at end of file