summaryrefslogtreecommitdiff
path: root/readme.txt
diff options
context:
space:
mode:
authorBenji Dial <benji@benjidial.net>2024-01-20 17:59:40 -0500
committerBenji Dial <benji@benjidial.net>2024-01-20 17:59:40 -0500
commit7199e74aa22e592a3b77bdd81f735edca5470596 (patch)
tree66e935372acc5d6e013f764965f2a9d81814f809 /readme.txt
parent53135e2592c21cb9b2609bf95242aaf1f19233da (diff)
downloadhilbert-os-7199e74aa22e592a3b77bdd81f735edca5470596.tar.gz
update
Diffstat (limited to 'readme.txt')
-rw-r--r--readme.txt43
1 files changed, 39 insertions, 4 deletions
diff --git a/readme.txt b/readme.txt
index cbde296..bdd8e45 100644
--- a/readme.txt
+++ b/readme.txt
@@ -7,7 +7,42 @@ then, just run "make -jx", replacing x with the number of threads to use
while building. this will create a bios-bootable disk image in out/disk.iso.
you can then test it in qemu with gdb attached by running "make run".
-hilbert uses the limine bootloader, which is downloaded during the make process
-into the limine directory. once that happens, you can find its license in
-limine/COPYING. hilbert also uses the terminus font, which is in the terminus
-directory. you can find its license in terminus/license.txt
+acknowledgements (* = downloaded during make):
+
+ - limine bootloader*
+ homepage: https://limine-bootloader.org/
+ license: limine/COPYING (bsd two-clause)
+
+ - terminus font
+ homepage: https://terminus-font.sourceforge.net/
+ license: terminus/license.txt (sil open font license v1.1)
+
+ - photo at skeleton/assets/burdon.ppm
+ photographer: aaron burdon
+ source: https://unsplash.com/photos/selective-focus-photography-snowflakes-9yhy1FXlKwI
+ license: https://unsplash.com/license
+
+ - mintsuki's freestanding c headers*
+ homepage: https://github.com/mintsuki/freestanding-headers
+ license: mintsuki-freestanding-headers/LICENSE (bsd zero-clause)
+
+project structure:
+
+ - applications/init: the first application started by the kernel
+ - applications/link.ld: a common linker script used by every application
+ - documentation: documentation on the kernel (not very organized)
+ - kernel: the kernel of hilbert os
+ - libraries/daguerre: an image loading / rendering library
+ - libraries/euler: the c++ standard library and runtime for applications
+ - limine: the limine bootloader (see acknowledgements)
+ - mintsuki-freestanding-headers:
+ mintsuki's freestanding headers (see acknowledgements)
+ - obj: built object files
+ - out: completed builds
+ - skeleton: files that are directly copied to the initfs
+ - terminus: the terminus font (see acknowledgements)
+ - license.txt: the license that hilbert os is under
+ - limine.cfg: the limine configuration used by the built disk
+ - makefile: the makefile that is used to build the entire os
+ - qmeu.gdb: a file for gdb to include when doing make run
+ - readme.txt: this file