readme and license and makefile
This commit is contained in:
parent
5efb690217
commit
3ad3625527
13
LICENSE
Normal file
13
LICENSE
Normal file
@ -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.
|
2
Makefile
2
Makefile
@ -30,7 +30,7 @@ clean:
|
|||||||
rm -rf kernel/Cargo.lock
|
rm -rf kernel/Cargo.lock
|
||||||
mkdir target
|
mkdir target
|
||||||
|
|
||||||
run-elf: target/kernel.elf
|
run-kernel: target/kernel.elf
|
||||||
qemu-system-i386 -kernel '$<'
|
qemu-system-i386 -kernel '$<'
|
||||||
|
|
||||||
run: target/main.iso
|
run: target/main.iso
|
||||||
|
31
README.md
31
README.md
@ -2,14 +2,31 @@
|
|||||||
|
|
||||||
Mixray's small OS
|
Mixray's small OS
|
||||||
|
|
||||||
## How to build
|
## How to use
|
||||||
|
|
||||||
```
|
```bash
|
||||||
make build
|
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
|
||||||
|
|
||||||
```
|
<ul><li>- [x] </li></ul> Hello World
|
||||||
make run
|
|
||||||
```
|
### 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
|
Loading…
Reference in New Issue
Block a user