diff --git a/docs/assets/images/MOP3_mutex_test.mp4 b/docs/assets/images/MOP3_mutex_test.mp4 new file mode 100644 index 0000000..7e5e29e Binary files /dev/null and b/docs/assets/images/MOP3_mutex_test.mp4 differ diff --git a/docs/index.md b/docs/index.md index 4c56140..01e323e 100644 --- a/docs/index.md +++ b/docs/index.md @@ -2,3 +2,32 @@ MOP3 is a hobby OS project of mine ;). + + + +## What does MOP3 mean? + +MOP stands for My OS Project. I've decided to call it that, because I didn't have a better idea for a name +and also most hobby OS names are really cringey/corny (tbh this one is too ;( ). 3 comes from the fact that this +is the third rewrite of the same OS - and I still reuse parts from older code in this project. + +## Deploying the OS via a live ISO + +The development infra is designed around Linux/POSIX utilites, so it will not work on Windows. I should put +this in a dockerfile, but that will have to wait. + +To build everything: + +``` +./aux/devel.sh +``` + +WARNING: This will write the ISO to your device of choice! Be careful! +``` +sudo ./aux/write_iso.sh /dev/myusb +sudo eject /dev/myusb +``` + +And now you can plug in your USB and boot it up! Enjoy ;).