summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md13
1 files changed, 9 insertions, 4 deletions
diff --git a/README.md b/README.md
index ca9e235..b27656e 100644
--- a/README.md
+++ b/README.md
@@ -2,9 +2,9 @@ The Hyra Operating System
=========================
Welcome to the Hyra Operating System project! Hyra is an experimental
-operating system inspired by BSD and Plan 9 while being entirely written
-entirely from scratch. Hyra aims to rethink core fundamentals in modern operating system design
-in order to create new and improved architectural ideas.
+operating system inspired by BSD and Plan 9 while being entirely written from scratch.
+Hyra aims to rethink core fundamentals in modern operating system design in order to
+create new and improved architectural ideas.
Project Goal:
@@ -72,7 +72,12 @@ And more! See ``lib/*``
Documentation:
--------------
-Documentation will be in the form of comments throughout the codebase and can also be found in the share/ directory within the project root.
+Documentation will be in the form of comments throughout the codebase and can also be found in:
+
+- ``share/man/*``: Man pages
+- ``share/contrib``: Information on contributing
+- ``share/docs/kernel``: Kernel documentation
+- ``share/docs/lib``: Library documentation
Hyra running on bare metal:
--------------