mercury/book
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Activity

Update some links & formatting

Browse source
This commit is contained in:
~erin 2023-04-17 23:01:09 -04:00
parent 04140376fa
commit 63f8cfb22a
Signed by untrusted user: erin
GPG key ID: 9A8E308CEFA37A47
3 changed files with 15 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
src/README.md
View file

@ -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! 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 ## Status
Right now, **Mercury** is mainly in the planning stage. 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. We're still setting things up, learning, and planning out how we're going to do this.

9
src/SUMMARY.md
View file

@ -2,15 +2,18 @@
[Introduction](README.md) [Introduction](README.md)
# Developer Guide
- [Development](development/README.md) - [Development](development/README.md)
- [Understanding the Design Goals](development/design/README.md) - [Understanding the Design Goals](development/design/README.md)
- [Actor System]() - [Actor System]()
- [Security Features]() - [Security Features]()
- [Microkernel]() - [Microkernel](development/design/kernel.md)
- [GUI]() - [GUI]()
- [Filesystem](development/design/filesystem.md) - [Filesystem](development/design/filesystem.md)
- [Configuring a Build Environment](development/environment.md) - [Configuring a Build Environment](development/environment.md)
- [Development Workflow](development/workflow.md) - [Development Workflow](development/workflow.md)
# User Guide
- [Using the OS](user/README.md) - [Using the OS](user/README.md)
- [Running in a Virtual Machine]() - [Running in a Virtual Machine]()
- [Running on Baremetal]() - [Running on Baremetal]()
@ -19,3 +22,7 @@
- [Navigating the GUI]() - [Navigating the GUI]()
- [Configuring the System]() - [Configuring the System]()
- [Working with Actors]() - [Working with Actors]()
-----------
[Code of Conduct]()

1
src/code-of-conduct.md Normal file
View file

@ -0,0 +1 @@
# Code of Conduct