From fab247e213f550fd9a05e14e0bc6b05152dfe552 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicol=C3=A1s=20Ortega=20Froysa?= Date: Thu, 8 Mar 2018 17:05:58 +0100 Subject: [PATCH] Added a README --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..293ffb8 --- /dev/null +++ b/README.md @@ -0,0 +1,14 @@ +UntrueOS +======== +This is a small OS project I'm working on. It's slow progress and probably shouldn't be run anywhere except in an emulator. It currently supports the following architectures: + - x86 + +Compiling +--------- +You'll want to setup a cross-compilation toolchain with [GCC](https://gcc.gnu.org/) for your target architecture, along with [GNU Make](https://www.gnu.org/software/make/) (I'll switch to the GNU autotools as soon as I can get them to work properly). + +To compile a full image you can run `make build-iso`, which will use [GNU GRUB](https://www.gnu.org/software/grub/) as the bootloader. Else, just run `make` and it will build the kernel into a file called `untrue.bin`. You can run the latter with [QEMU](https://www.qemu.org/) by using the `-kernel` option. + +License +------- +This project is licensed under the terms and conditions of the [GNU General Public License version 3 or greater](/LICENSE).