diff options
| author | sigsegv7 <ian@vegaa.systems> | 2023-09-20 01:41:08 -0400 |
|---|---|---|
| committer | sigsegv7 <ian@vegaa.systems> | 2023-09-20 01:41:08 -0400 |
| commit | 248f6d10503f628ccd64e9869fa802cc1bb8b3a1 (patch) | |
| tree | c7ba500c9859a2c673e42f8788cbb99542df3f1e | |
| parent | 1241e5e7e525b22a28151880cb9e78ac23766055 (diff) | |
docs: Add README
Signed-off-by: sigsegv7 <ian@vegaa.systems>
| -rw-r--r-- | README | 45 |
1 files changed, 45 insertions, 0 deletions
@@ -0,0 +1,45 @@ +The Vega Operating System +===================== + +Welcome to the Vega Operating System project! + +Project Goal: +-------------- +The goal of this project is to create a modern operating system, taking inspiration from NetBSD and incorporating new ideas and design plans. Our mission is to design a new modernized POSIX-like standard to provide a robust and versatile environment for developers and users. + +Getting Started: +---------------- +To build VegaOS you'll need to bootstrap the project which is essentially just fetching dependencies for the project. This can be done by running the bootstrap script within the project root: `./bootstrap`. + +Next, to configure for x86_64 just run configure: + +`./configure` + +Now you'll need to build the cross compiler by running: + +`make cross` + +This may take awhile so just sit back, relax and do something else like... well I'm not you so +I don't know what you like. + +After the cross compiler is done building you can build and run the project in a virtual machine: + +`make; make run` + +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. + +License: +-------- +This project is licensed under the BSD-3 clause (SPDX Identifier: BSD-3-Clause) + +Contact: +--------- + +Original Founder: +Ian Moffett <ian@vegaa.systems> + +Co-founders: +Quinn Stephens <quinn@vegaa.systems> +Eduardo <ed@vegaa.systems> |