diff options
| author | Danny Holman <dholman@gymli.xyz> | 2021-01-28 19:08:31 -0600 |
|---|---|---|
| committer | Danny Holman <dholman@gymli.xyz> | 2021-01-28 19:08:31 -0600 |
| commit | 9e9c555ead1d7dbc509f5538a7bd2747ca6cadfa (patch) | |
| tree | cb655d26efa4b9908dbf7f1882340e2cd5631a4e | |
| parent | 12c900f24ebd717c0de79dec804f39b6235d4cfa (diff) | |
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 <dholman@gymli.xyz>
| -rw-r--r-- | README.md | 14 |
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 |