diff options
| author | Peter Mikkelsen <petermikkelsen10@gmail.com> | 2025-07-26 16:15:54 +0200 |
|---|---|---|
| committer | Peter Mikkelsen <petermikkelsen10@gmail.com> | 2025-07-26 16:15:54 +0200 |
| commit | fdef211fd968c6a3ff0ca6ca38620e8c13387c4c (patch) | |
| tree | 49fa230b0bee9adb3c299d41c84eee1bd3af2dec /README.md | |
| parent | f199eae0154f354c37750c8cd3037f94dbfe70db (diff) | |
Add a license and a readme
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..94116e6 --- /dev/null +++ b/README.md @@ -0,0 +1,10 @@ +This project is an experiment to create an operating system which has only one goal: to run APL programs. + +# Getting started +Just clone the repository and run `make`. +Interesting makefile targets include `run` and `dbg`. + +It is very possible that you might need to install some stuff (such as gcc and qemu) before everything works, but it should be obvious what is needed by looking at the error messages. + +# External dependencies +The project depends on the limine bootloader and the spleen fonts, both of which are downloaded automatically by the makefile. |