From 5a6036560463602c03c2d65fc790e5023b13bfec Mon Sep 17 00:00:00 2001 From: Ellen Marie Dash Date: Fri, 28 Sep 2018 20:41:42 -0400 Subject: [PATCH] Update with links to documentation and such. --- _config.yml | 2 +- _layouts/default.html | 1 + index.markdown | 80 ++++++++++++++++++++----------------------- 3 files changed, 40 insertions(+), 43 deletions(-) diff --git a/_config.yml b/_config.yml index bdcd6f6..b200ca6 100644 --- a/_config.yml +++ b/_config.yml @@ -5,7 +5,7 @@ timezone: America/New_York markdown: redcarpet redcarpet: - extensions: [with_toc_data] + extensions: [footnotes, tables, with_toc_data] url: https://awoo.onl diff --git a/_layouts/default.html b/_layouts/default.html index d80f3de..d49bd3f 100644 --- a/_layouts/default.html +++ b/_layouts/default.html @@ -23,6 +23,7 @@

awooOS

diff --git a/index.markdown b/index.markdown index b2d182f..b0dc2d5 100644 --- a/index.markdown +++ b/index.markdown @@ -1,49 +1,45 @@ --- --- -**If you'd like to fund work on awooOS, you can [donate to -duckinator on liberapay](https://liberapay.com/duckinator/).** +**If you like awooOS, you can help fund it by donating to duckinator on +[liberapay](https://liberapay.com/duckinator/) or +[Patreon](https://patreon.com/duckinator).** -awooOS is an experimental operating system, aiming at modernizing and -simplifying kernel development. +awooOS is an experimental operating system, attempting to modernize and +simplify kernel development. -Code reuse is a very important aspect of this project. As such, +Code reuse is an important aspect of this project. For this reason, functionality is divided into individual libraries, services, and tools. +All of these are released under the MIT license. -For the same reason, all code for awooOS is released under the MIT -license, allowing easy integration into other codebases. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
LibraryPurpose
alia libc implementation.
dmmmemory management library.
eventuallyevent handler and dispatch library.
flailkernel panic library.
halhardware abstraction layer
schedulerprocess scheduler.
tinkerkernel testing framework.
+## Libraries + +The kernel itself is around 50 LOC, with everything else being implemented +as libraries. + +NOTE: In the table below, "libc" and "ali" are listed as distinct +dependencies, because ali accumulated nonstandard components during +experimentation. This needs to be resolved in some way. + +| Library | Purpose | Required Deps | Optional Deps | +|-------------|-------------------|--------------------------|---------------| +| [ali][1] | libc, events | memory manager | Tinker | +| [cadel][2] | graphics | (unknown) | (unknown) | +| [dmm][3] | memory manager | libc (stddef.h, stdint.h)| Tinker | +| [flail][4] | kernel panics | libc (stddef.h, stdint.h)| Tinker | +| greeter[^1] | boot-time greetng | Ali (event, text) | (none) | +| [hal][5][^1]| hardware abstraction layer | libc, Ali, DMM, Flail | Tinker| +| shell[^1] | minimal shell | libc, Ali (event, str) | (none) | +| tests[^2] | Tinker integration| Ali, Tinker.[^3] | ??? | +| [tinker][6] | kernel test framework | libc, Ali (number) | (none) | + +[^1]: Planned to eventually be removed from the source tree. +[^2]: awooOS-specific, and thus will remain in the awooOS source tree. +[^3]: the awooOS-specific `tests` library depends on every library awooOS links to that uses Tinker. + +[1]: https://github.com/awooos/ali +[2]: https://github.com/awooos/cadel +[3]: https://github.com/awooos/dmm +[4]: https://github.com/awooos/flail +[5]: https://github.com/awooos/hal +[6]: https://github.com/awooos/tinker