os/README.md

# os
A very basic bootloader & operating system, written in x86 assembly and C++.

I'm using this as a learning project, so it's not very functional.

## Building
To build this, you need the basics (GCC/G++, Make, NAsm) and QEmu to run. The operating system is built for x86, 32-bit processor.

Using make, you can build by running `make all`. To run with QEmu using the default settings, you can run `make run`.

## References
The basis for this project was formed as I worked through the book _Writing a Simple Operating System -- from Scratch_ by Nick Blundell.

Some code was referenced/adapted from [a repository](https://github.com/cfenollosa/os-tutorial) based on on the same book created by Carlos Fenollosa.

## License
```txt
Copyright 2021 Garrett L. Mills.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
IN THE SOFTWARE.
```