From 587a8c0550a8102586702778dc4fd367b6d27563 Mon Sep 17 00:00:00 2001 From: Ticki <Ticki@users.noreply.github.com> Date: Mon, 29 Feb 2016 08:27:17 +0100 Subject: [PATCH] Really shitty first chapter --- index.txt | 5 +++-- overview/developers.md | 33 +++++++++++++++++++++++++++++++++ overview/side_projects.md | 22 ++++++++++++++++++++++ overview/the_structure.md | 15 +++++++++++++++ overview/welcome.md | 6 ++++++ overview/what_redox_is.md | 12 ++++++++++++ 6 files changed, 91 insertions(+), 2 deletions(-) create mode 100644 overview/developers.md create mode 100644 overview/side_projects.md create mode 100644 overview/the_structure.md create mode 100644 overview/welcome.md create mode 100644 overview/what_redox_is.md diff --git a/index.txt b/index.txt index 6b8c9a9..a43a93f 100644 --- a/index.txt +++ b/index.txt @@ -1,7 +1,8 @@ Overview -.... What is Redox? +.... What Redox is .... The structure .... Side-projects +.... Developers Introduction .... What is Redox? @@ -18,7 +19,7 @@ Getting started .... Compiling Redox .... Using Redox -Design +The design .... URLs, schemes and resources ........ Overview ........ URLs diff --git a/overview/developers.md b/overview/developers.md new file mode 100644 index 0000000..fc482af --- /dev/null +++ b/overview/developers.md @@ -0,0 +1,33 @@ +Developers +========== + +We are quite a few developers at Redox. 40+ people working on it. All sorts of cool people to work with. + +Our BDFL is Jeremy Soller (Jackpot51), who maintains the kernel, Orbital (and OrbTK), and the overall direction of the project. + +The other side projects have different BDFLs: + +- Ion: Skyler Berg. +- Sodium: Ticki. +- The implementation of ZFS: Formerly Tedsta, now Ticki. +- Oxide: Ticki +- Coreutils: Ticki. +- Extrautils: Ticki. +- Binutils: Ticki. + +The "core team" (people who are regularly contributing to Redox) is currently: + +(alphabetically sorted) + +- hauleth +- henrikhodne +- jackpot51 +- k0pernicus +- mgattozzi +- roxxik +- skylerberg +- stratact +- tedsta +- ticki + +But [don't](https://github.com/redox-os/redox/graphs/contributors) [forget](https://github.com/redox-os/coreutils/graphs/contributors) [all](https://github.com/redox-os/sodium/graphs/contributors) [the](https://github.com/redox-os/ion/graphs/contributors) [other](https://github.com/redox-os/orbtk/graphs/contributors) [awesome](https://github.com/redox-os/orbclient/graphs/contributors) [contributors](https://github.com/redox-os/redox/graphs/contributors). diff --git a/overview/side_projects.md b/overview/side_projects.md new file mode 100644 index 0000000..9b5ecb4 --- /dev/null +++ b/overview/side_projects.md @@ -0,0 +1,22 @@ +Side projects +============= + +You might have noticed that Redox is more than a kernel. Redox is a complete Rust operating system. + +We got a number of Rust side project, which are developed for Redox, to make up a complete function OS: + +- Orbital: The display server of Redox. +- OrbTK: An widget toolkit. +- Ion: The Redox shell. +- Sodium: A Vi-like editor. +- An implementation of ZFS. +- Oxide: Redox's package manager. + +It is worth noting that all of the side-projects are pure, custom-written Rust. + +We also have three different utility distribution, which are collections of small, useful command-line programs: +- Coreutils: A minimal set of utilities, which are essential for an usable system. +- Extrautils: Some extra utilities (like reminders, calendars, spellcheck, and so on). +- Binutils: Utilities for working with binary files. + +Why not just use some already written programs? Because, we want a **Rust** operating system. Later, we will expand on why using Rust is important to us, and why you should care! diff --git a/overview/the_structure.md b/overview/the_structure.md new file mode 100644 index 0000000..d0e492e --- /dev/null +++ b/overview/the_structure.md @@ -0,0 +1,15 @@ +The structure +============= + +The book is broken into 8 parts: + +- Overview: A quick'n'dirty overview of Redox. +- Introduction: Explanation of what Redox is and how it compares to other systems. +- Getting started: Compiling and running Redox. +- The design: An in-depth introduction to the design and implementation of Redox. +- Development in userspace: Writing applications for Redox. +- Contributing: How you can contribute to Redox. +- Fun: Top secret chapter. +- The future: What Redox aims to be. + +It is written such that you do not need any prior knowledge in Rust and/or OS development. diff --git a/overview/welcome.md b/overview/welcome.md new file mode 100644 index 0000000..dd1b56d --- /dev/null +++ b/overview/welcome.md @@ -0,0 +1,6 @@ +Welcome! +======== + +This is the Redox book, which will go through (almost) everything about Redox: design, philosophy, how it works, how you can contribute, how to deploy Redox, and much more. + +This book was written by Ticki. diff --git a/overview/what_redox_is.md b/overview/what_redox_is.md new file mode 100644 index 0000000..da5b7d5 --- /dev/null +++ b/overview/what_redox_is.md @@ -0,0 +1,12 @@ +What Redox is +============= + +Redox is an general purpose operating system and surrounding ecosystem written in pure Rust. Our aim is to provide a fully functioning Linux replacement, without the bad parts. + +We have a modest compatibility with Linux syscalls, making Redox able to run many Linux program without any form of virtualization. + +We take inspiration from Plan9, Minix, and BSD. We are trying to generalize various concepts from other systems, to get one unified design. We will speak about this some more in the `Design` chapter. + +Redox runs on real hardware today. + +TODO: Make this better. -- GitLab