From f88d51ef6c5b93ac9d14e06389e4212291d46248 Mon Sep 17 00:00:00 2001 From: Ribbon Date: Fri, 21 Feb 2025 00:18:19 +0000 Subject: [PATCH] Improve the README and fix a broken link --- README.md | 28 +++++++++++++++------------- 1 file changed, 15 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 6b5c2225f..443440c80 100644 --- a/README.md +++ b/README.md @@ -2,17 +2,19 @@ Redox

-This repository is the **Build System** for Redox OS. Redox is under active development by a vibrant community. Key links: +This repository is the **Build System** for Redox OS. + +Redox is under active development by a vibrant community, you can see the key links below: - [The **main website** for Redox OS](https://www.redox-os.org). -- [The Redox Book](https://doc.redox-os.org/book/) and [Build Instructions](https://doc.redox-os.org/book/building-redox.html). +- [The Redox Book](https://doc.redox-os.org/book/) and [Build Instructions](https://doc.redox-os.org/book/podman-build.html). - [Redox Chat and Support](https://matrix.to/#/#redox-join:matrix.org). - [Patreon](https://www.patreon.com/redox_os), [Donate](https://redox-os.org/donate/) and [Merch](https://redox-os.creator-spring.com/). -- Scroll down for a list of key Redox components and their repos. +- Scroll down for a list of key Redox components and their repositories. -[Redox](https://www.redox-os.org) is an operating system written in Rust, a language with focus on safety, efficiency and high performance. Redox uses a microkernel architecture, and aims to be reliable, secure, usable, correct, and free. Redox is inspired by previous operating systems, such as seL4, MINIX, Plan 9, Linux and BSD. +[Redox](https://www.redox-os.org) is an open-source operating system written in Rust, a language with focus on safety, efficiency and high performance. Redox uses a microkernel architecture, and aims to be reliable, secure, usable, correct, and free. Redox is inspired by previous operating systems, such as seL4, MINIX, Plan 9, Linux and BSD. -Redox _is not_ just a kernel, it's a **full-featured operating system**, providing components (file system, display manager, core utilities, etc.) that together make up a functional and convenient operating system. Redox uses the COSMIC desktop apps, and provides source code compatibility with many Rust, Linux and BSD programs. +Redox _is not_ just a kernel, it's a **full-featured operating system**, providing components (file system, display server, core utilities, etc.) that together make up a functional and convenient operating system. Redox uses the COSMIC desktop apps, and provides source code compatibility with many Rust, Linux and BSD programs. [![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE) @@ -21,9 +23,9 @@ Redox _is not_ just a kernel, it's a **full-featured operating system**, providi - [Book](https://doc.redox-os.org/book/) - [Contribute](CONTRIBUTING.md) - [Hardware Compatibility](https://doc.redox-os.org/book/hardware-support.html) -- Run Redox in a [Virtual Machine](https://doc.redox-os.org/book/running-vm.html) or on [Real Hardware](https://doc.redox-os.org/book/ch02-02-real-hardware.html) +- Run Redox in a [Virtual Machine](https://doc.redox-os.org/book/running-vm.html) or on [Real Hardware](https://doc.redox-os.org/book/real-hardware.html) - [Trying Out Redox](https://doc.redox-os.org/book/trying-out-redox.html) -- [Building Redox](https://doc.redox-os.org/book/building-redox.html) +- [Building Redox](https://doc.redox-os.org/book/podman-build.html) - [Build System Documentation](https://doc.redox-os.org/book/build-system-reference.html) - [Developer FAQ](https://doc.redox-os.org/book/developer-faq.html) - [Chat/Discussions/Help](https://doc.redox-os.org/book/chat.html) @@ -37,15 +39,15 @@ Some of the key repositories on the Redox GitLab: | [Kernel](https://gitlab.redox-os.org/redox-os/kernel) | **@jackpot51** | [RedoxFS (default filesystem)](https://gitlab.redox-os.org/redox-os/redoxfs) | **@jackpot51** | [Drivers](https://gitlab.redox-os.org/redox-os/drivers) | **@jackpot51** -| [Orbital (windowing and compositing system)](https://gitlab.redox-os.org/redox-os/orbital) | **@jackpot51** +| [Orbital (display server and window manager)](https://gitlab.redox-os.org/redox-os/orbital) | **@jackpot51** | [pkgutils (current package manager)](https://gitlab.redox-os.org/redox-os/pkgutils) | **@jackpot51** -| [relibc (C Library in Rust)](https://gitlab.redox-os.org/redox-os/relibc) | **@jackpot51** -| [netstack (protocol stack)](https://gitlab.redox-os.org/redox-os/netstack) | **@jackpot51** -| [Ion (shell)](https://gitlab.redox-os.org/redox-os/ion) | **@jackpot51** +| [relibc (C POSIX library written in Rust)](https://gitlab.redox-os.org/redox-os/relibc) | **@jackpot51** +| [netstack (network stack)](https://gitlab.redox-os.org/redox-os/netstack) | **@jackpot51** +| [Ion (defauilt shell)](https://gitlab.redox-os.org/redox-os/ion) | **@jackpot51** | [Termion (terminal library)](https://gitlab.redox-os.org/redox-os/termion) | **@jackpot51** | This repo - the root of the Build System | **@jackpot51** -| [cookbook (Build System for components)](https://gitlab.redox-os.org/redox-os/cookbook) | **@jackpot51** **@hatred_45** -| [Redoxer (Build/Test for Redox compatibility verification)](https://gitlab.redox-os.org/redox-os/redoxer) | **@jackpot51** +| [cookbook (Build system for system components and programs)](https://gitlab.redox-os.org/redox-os/cookbook) | **@jackpot51** **@hatred_45** +| [Redoxer (Tool for Redox development testing)](https://gitlab.redox-os.org/redox-os/redoxer) | **@jackpot51** | [The Redox Book](https://gitlab.redox-os.org/redox-os/book) | **@hatred_45** ## What it looks like