From 9e9c555ead1d7dbc509f5538a7bd2747ca6cadfa Mon Sep 17 00:00:00 2001 From: Danny Holman Date: Thu, 28 Jan 2021 19:08:31 -0600 Subject: README: add project README file Add a README to the root of the project. This will act as a point of information to new users/developers. Signed-off-by: Danny Holman --- 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..17c37f2 --- /dev/null +++ b/README.md @@ -0,0 +1,14 @@ +# BoxOS + +Box is a simple Unix clone that runs on 32-bit, x86 family of processors. It is +written in C with a small portion written in assembly. + +## Compiling + +You will need the following to compile the Box kernel: +* i686-elf toolchain +* A working Unix environment + +## Copyright + +Copyright (C) 2021 Danny Holman, dholman@gymli.xyz -- cgit v1.2.3