From 63f8cfb22a7cdc3fa7fe28d6fe536b454a31fcb4 Mon Sep 17 00:00:00 2001 From: Erin Abicht Date: Mon, 17 Apr 2023 23:01:09 -0400 Subject: [PATCH] Update some links & formatting --- src/README.md | 6 ++++++ src/SUMMARY.md | 9 ++++++++- src/code-of-conduct.md | 1 + 3 files changed, 15 insertions(+), 1 deletion(-) create mode 100644 src/code-of-conduct.md diff --git a/src/README.md b/src/README.md index 819ef2f..14c3ea9 100644 --- a/src/README.md +++ b/src/README.md @@ -7,6 +7,12 @@ It consists of docs for [Developers](/development/index.md), as well as [end-use If you would like to use the operating system, or help with development, this is where to get your information! +## What is Mercury? +**Mercury**, or the **Mercury Project**, refers to the collection of `libraries`, `crates`, and other code under this organization. +"Organization" is a loose term, and really it's anyone who contributes and follows the [Code of Conduct](code-of-conduct.md). + +**Mercury OS** refers specifically to the full Operating System built off of the `ferrite` [kernel](/development/design/kernel.md) and all the other binaries. + ## Status Right now, **Mercury** is mainly in the planning stage. We're still setting things up, learning, and planning out how we're going to do this. diff --git a/src/SUMMARY.md b/src/SUMMARY.md index 14ee99b..29134bb 100644 --- a/src/SUMMARY.md +++ b/src/SUMMARY.md @@ -2,15 +2,18 @@ [Introduction](README.md) +# Developer Guide - [Development](development/README.md) - [Understanding the Design Goals](development/design/README.md) - [Actor System]() - [Security Features]() - - [Microkernel]() + - [Microkernel](development/design/kernel.md) - [GUI]() - [Filesystem](development/design/filesystem.md) - [Configuring a Build Environment](development/environment.md) - [Development Workflow](development/workflow.md) + +# User Guide - [Using the OS](user/README.md) - [Running in a Virtual Machine]() - [Running on Baremetal]() @@ -19,3 +22,7 @@ - [Navigating the GUI]() - [Configuring the System]() - [Working with Actors]() + +----------- + +[Code of Conduct]() diff --git a/src/code-of-conduct.md b/src/code-of-conduct.md new file mode 100644 index 0000000..38fc14f --- /dev/null +++ b/src/code-of-conduct.md @@ -0,0 +1 @@ +# Code of Conduct