summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md14
1 files changed, 14 insertions, 0 deletions
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