Update The README :)

This commit is contained in:
Tyler McGurrin 2025-05-30 09:39:07 -04:00
parent b0b2b4e9e5
commit 3567925f50

View File

@ -1,21 +1,31 @@
# Nanite # Nanite
Very small OS that can run on X86 Hardware. Very small OS that can run on X86 Hardware.
Fits on anything from a 320K Floppy to a 1.44MB Floppy (i however ONLY make 1.44MB Images, as i only have 1.44MB floppies). Designed to run from just one 1.44MB floppy disk, ATA support coming soon! (TM)
Good luck reading my terrible X86 ASM and C (my C code is ok, x86 ASM however...).
I work on this in my spare time so don't really expect much work being done to it 24/7. Good luck figuring out the spagetti code i write... (sorry not sorry ;D)
I am designing it for older computers such as a Pentium (i586) system i would recomend atleast a Pentium 4 however.
Designed for older computers such as a Pentium (i586) Class Machine. I would recomend atleast a Pentium 2 Class or higher system however.
## Features ## Features
A funtioning Bootloader and half working kernel. A funtioning Bootloader and half working kernel.
Also some tools for the FAT filesystem (host system). Also some tools for the FAT filesystem (host system).
Kernel is currently INDEV. Kernel is currently under heavy development.
## How do I Test Builds?
Early Hardware tesing was done on a Pentium 2 @ 300MHz with 192MB of Ram (Panasonic Toughbook CF-27 MKII). ## How To Build
It has now moved to my main laptop, a Dell Latitude D610, (2GB RAM, 2.23GHZ Pentium M). You Basically Run `./build.sh` to build it
Testing is also done with QEMU and previously BOCHS (not anymore as it almost crashes my system if I even think about running it).
## Thanks If you wanted to write it to a floppy disk you can use `write.sh` tho be careful as the value for what drive it uses is hard coded as /dev/sdb
Thanks to Nanobyte and the OSDEV wiki for providing resources for me to be able to make this.
## How is Testing Done
Testing is mostly done with QEMU These days, but I do sometimes pull out my Dell Latitude D610 to test on (for anyone wondering its completely maxed out. [2GB of ram Pentium M @ 2.23GHz])
## Thanks!
Nanobyte and the OSDEV wiki for providing resources for me to be able to make this.
- Nanobyte's Youtube Channel: https://www.youtube.com/@nanobyte-dev - Nanobyte's Youtube Channel: https://www.youtube.com/@nanobyte-dev
- OSDEV Wiki: https://wiki.osdev.org/Expanded_Main_Page - OSDEV Wiki: https://wiki.osdev.org/Expanded_Main_Page
And also a thanks to King Gizzard and The Lizzard Wizzard, without their music to allow me to power through long ass all-nighters I highly doubt I would've made this. And thanks to some of my favorite bands for some nice ass music!
They can be found here: https://kinggizzardandthelizardwizard.com/ - King Gizzard and The Lizzard Wizzard
- Nine Inch Nails
- The Strokes
(and if your wondering, yes im a massive nerd about music)