diff --git a/README.md b/README.md index dbacc4b..97c5c22 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@ Please make sure you use the **latest nightly** of `rustc` before building (for ## Contents -* [What it looks like](#what-it-looks-like) +* [What it looks like](#screenshots) * [Ecosystem](#ecosystem) * [Help! Redox won't compile](#compile-help) * [Contributing to Redox](#contributing) @@ -24,7 +24,7 @@ Please make sure you use the **latest nightly** of `rustc` before building (for * [Quick Setup](#quick-setup) * [Manual Setup](#manual-setup) -## What it looks like +## What it looks like Redox Redox @@ -40,9 +40,9 @@ The ecosystem and software Redox OS provides is listed below. | Name (lexicographic order) | Maintainer |-----------------------------------------------------------------------------|--------------------------- -| [acid tests](https://github.com/redox-os/acid) | [**@jackpot51**](https://github.com/jackpot51) (co.: [**@ticki**](https://github.com/ticki), [**@nilset](https://github.com/nilset)) +| [acid (kernel integration tests)](https://github.com/redox-os/acid) | [**@jackpot51**](https://github.com/jackpot51) (co.: [**@ticki**](https://github.com/ticki), [**@nilset](https://github.com/nilset)) | [binutils](https://github.com/redox-os/binutils) | [**@ticki**](https://github.com/ticki) -| [bots (other internal bots)](https://github.com/redox-os/bots) | [**@ticki**](https://github.com/ticki) +| [bots (custom Mattermost bots)](https://github.com/redox-os/bots) | [**@ticki**](https://github.com/ticki) | [cookbook](https://github.com/redox-os/cookbook) | [**@jackpot51**](https://github.com/jackpot51) | [coreutils](https://github.com/redox-os/coreutils) | [**@ticki**](https://github.com/ticki) (co.: [**@stratact**](https://github.com/stratact)) | [extrautils](https://github.com/redox-os/extrautils) | [**@ticki**](https://github.com/ticki) @@ -51,23 +51,23 @@ The ecosystem and software Redox OS provides is listed below. | [kernel](https://github.com/redox-os/kernel) | [**@jackpot51**](https://github.com/jackpot51) | [libextra](https://github.com/redox-os/libextra) | [**@ticki**](https://github.com/ticki) | [libpager](https://github.com/redox-os/libpager) | [**@ticki**](https://github.com/ticki) -| [magnet (future package manager)](https://github.com/redox-os/magnet) | [**@ticki**](https://github.com/ticki) +| [Magnet (future package manager)](https://github.com/redox-os/magnet) | [**@ticki**](https://github.com/ticki) | [netutils](https://github.com/redox-os/netutils) | [**@jackpot51**](https://github.com/jackpot51) -| [orbclient](https://github.com/redox-os/orbclient) | [**@jackpot51**](https://github.com/jackpot51) +| [orbclient (orbital client)](https://github.com/redox-os/orbclient) | [**@jackpot51**](https://github.com/jackpot51) | [orbdata](https://github.com/redox-os/orbdata) | [**@jackpot51**](https://github.com/jackpot51) -| [orbital](https://github.com/redox-os/orbital) | [**@jackpot51**](https://github.com/jackpot51) -| [orbtk](https://github.com/redox-os/orbtk) | [**@stratact**](https://github.com/stratact) -| [orbutils](https://github.com/redox-os/orbutils) | [**@jackpot51**](https://github.com/jackpot51) +| [Orbital (windowing and compositing system](https://github.com/redox-os/orbital) | [**@jackpot51**](https://github.com/jackpot51) +| [orbtk (orbital toolkit)](https://github.com/redox-os/orbtk) | [**@stratact**](https://github.com/stratact) +| [orbutils (orbital utilities))](https://github.com/redox-os/orbutils) | [**@jackpot51**](https://github.com/jackpot51) | [pkgutils (current package manager)](https://github.com/redox-os/pkgutils) | [**@jackpot51**](https://github.com/jackpot51) | [playbot (internal REPL bot)](https://github.com/redox-os/playbot) | [**@ticki**](https://github.com/ticki) | [ralloc](https://github.com/redox-os/ralloc) | [**@ticki**](https://github.com/ticki) -| [RANSID](https://github.com/redox-os/ransid) | [**@jackpot51**](https://github.com/jackpot51) +| [RANSID (rust ANSI driver)](https://github.com/redox-os/ransid) | [**@jackpot51**](https://github.com/jackpot51) | [redoxfs (old filesystem)](https://github.com/redox-os/redoxfs) | [**@jackpot51**](https://github.com/jackpot51) | [syscall](https://github.com/redox-os/syscall) | [**@jackpot51**](https://github.com/jackpot51) -| [Sodium (editor)](https://github.com/redox-os/sodium) | [**@ticki**](https://github.com/ticki) -| [Standard library](https://github.com/redox-os/libstd) | [**@jackpot51**](https://github.com/jackpot51) +| [Sodium (vim-inspired text editor)](https://github.com/redox-os/sodium) | [**@ticki**](https://github.com/ticki) +| [libstd (Redox standard library](https://github.com/redox-os/libstd) | [**@jackpot51**](https://github.com/jackpot51) | [userutils](https://github.com/redox-os/userutils) | [**@jackpot51**](https://github.com/jackpot51) -| [TFS (filesystem)](https://github.com/ticki/tfs) | [**@ticki**](https://github.com/ticki) +| [TFS (ticki filesystem)](https://github.com/ticki/tfs) | [**@ticki**](https://github.com/ticki) | [The Redox book](https://github.com/redox-os/book) | [**@ticki**](https://github.com/ticki) | [The old kernel](https://github.com/redox-os/old) | **abandoned** | [ZFS](https://github.com/redox-os/zfs) | **abandoned, superseded by TFS** @@ -77,8 +77,8 @@ The ecosystem and software Redox OS provides is listed below. Sometimes things go wrong when compiling. Try the following before opening an issue: 1. Run `make clean`. -2. Run `git clean -X -f -d`. -3. Make sure you have **the latest version of Rust nightly!** ([rustup.rs](https://www.rustup.rs) is recommended for managing Rust versions). +2. Run `git clean -Xfd`. +3. Make sure you have **the latest version of Rust nightly!** ([rustup.rs](https://www.rustup.rs) is recommended for managing Rust versions. If you already have it, run `rustup`). 4. Update **GNU Make**, **NASM** and **QEMU/VirtualBox**. 5. Pull the upstream master branch (`git remote add upstream git@github.com:redox-os/redox.git; git pull upstream master`). 6. Update submodules (`git submodule update --recursive --init`). @@ -91,7 +91,7 @@ If you're interested in this project, and you'd like to help us out, [here](CONT ## Cloning, Building, and Running -Redox is big (even compressed)! So cloning Redox takes a lot of bandwidth, and (depending on your data plan) can be costly, so clone at your own risk! +Redox is big, even compressed. Downloading the full history may take a lot of bandwidth, and can even be costly on some data plans. Clone at your own risk! ### Quick Setup @@ -112,11 +112,11 @@ $ make qemu kvm=no #### QEMU with KVM -To use QEMU with KVM (kernel-based virtual Machine), which is faster than without KVM, you need a CPU with Intel® Virtualization Technology (Intel® VT) or AMD Virtualization™ (AMD-V™) support. Most systems have this disabled in the BIOS by default, so you may need to reboot and enable the feature in the BIOS. +To use QEMU with KVM (kernel-based virtual Machine), which is faster than without KVM, you need a CPU with Intel® Virtualization Technology (Intel® VT) or AMD Virtualization™ (AMD-V™) support. Most systems have this disabled by default, so you may need to reboot, go into the BIOS, and enable it. ### Manual Setup -To manually clone, build and run Redox using a Linux host, run the following commands (with exceptions, be sure to read the comments): +To manually clone, build and run Redox using a Unix-based host, run the following commands (with exceptions, be sure to read the comments): ```bash $ cd path/to/your/projects/folder/ @@ -128,7 +128,7 @@ $ git clone git@github.com:redox-os/redox.git --origin upstream --recursive $ cd redox/ # Install/update dependencies -$ bash bootstrap.sh -d +$ ./bootstrap.sh -d # Install rustup.rs $ curl https://sh.rustup.rs -sSf | sh @@ -149,3 +149,4 @@ $ make qemu # Launch using QEMU without using KVM (Kernel Virtual Machine). Try if QEMU gives an error. $ make qemu kvm=no ``` +