vinzenz/redox
0
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity
redox/README.md

85 lines
6.3 KiB
Markdown
Raw Normal View History

Prepare the README for moving the kernel out. (#733) * Prepare the README for moving the kernel out. * Embolden the usernames and hyperlink them to the userpages. * Hyperlink nilset's username. * Grammar fixes, add Plan 9.
2016-11-03 16:06:24 +01:00
<p align="center">
Change github links in README
2018-08-26 18:13:54 +02:00
<img alt="Redox" width="346" src="https://gitlab.redox-os.org/redox-os/assets/raw/master/logos/redox/logo.png">
Prepare the README for moving the kernel out. (#733) * Prepare the README for moving the kernel out. * Embolden the usernames and hyperlink them to the userpages. * Hyperlink nilset's username. * Grammar fixes, add Plan 9.
2016-11-03 16:06:24 +01:00
</p>
Add guidelines in the README. This commits details the guidelines for contributing to the repository.
2016-08-14 00:53:13 +02:00
Fix capitalization
2017-09-20 18:23:16 +02:00
**Redox** is an operating system written in Rust, a language with focus on safety and high performance. Redox, following the microkernel design, aims to be secure, usable, and free. Redox is inspired by previous kernels and operating systems, such as SeL4, MINIX, Plan 9, and BSD.
Add guidelines in the README. This commits details the guidelines for contributing to the repository.
2016-08-14 00:53:13 +02:00
Big README cleanup/improvements.
2023-03-02 08:40:53 +01:00
Redox _is not_ just a kernel, it's a **full-featured Operating System**, providing packages (memory allocator, file system, display manager, core utilities, etc.) that together make up a functional and convenient operating system. You can loosely think of it as the GNU or BSD ecosystem, but in a memory safe language and with modern technology.
Prepare the README for moving the kernel out. (#733) * Prepare the README for moving the kernel out. * Embolden the usernames and hyperlink them to the userpages. * Hyperlink nilset's username. * Grammar fixes, add Plan 9.
2016-11-03 16:06:24 +01:00
Add hardware compatibility
2022-11-11 22:52:57 +01:00
The website can be found at https://www.redox-os.org. For hardware compatibility, see [HARDWARE.md](HARDWARE.md).
Add guidelines in the README. This commits details the guidelines for contributing to the repository.
2016-08-14 00:53:13 +02:00
Big README cleanup/improvements.
2023-03-02 08:40:53 +01:00
Please make sure you use the **latest nightly** of `rustc` before building (for more troubleshooting, see [Troubleshooting the Build](https://doc.redox-os.org/book/ch08-05-troubleshooting.html)).
Add guidelines in the README. This commits details the guidelines for contributing to the repository.
2016-08-14 00:53:13 +02:00
Change github links in README
2018-08-26 18:13:54 +02:00
[![Downloads](https://img.shields.io/github/downloads/redox-os/redox/total.svg)](https://gitlab.redox-os.org/redox-os/redox/tags)
Update README.md
2018-01-16 17:12:11 +01:00
[![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE)
Add guidelines in the README. This commits details the guidelines for contributing to the repository.
2016-08-14 00:53:13 +02:00
Big README cleanup/improvements.
2023-03-02 08:40:53 +01:00
## What it looks like
Add guidelines in the README. This commits details the guidelines for contributing to the repository.
2016-08-14 00:53:13 +02:00
Big README cleanup/improvements.
2023-03-02 08:40:53 +01:00
See [Redox in Action](https://www.redox-os.org/screens/).
Add guidelines in the README. This commits details the guidelines for contributing to the repository.
2016-08-14 00:53:13 +02:00
Restore GitLab screenshots.
2023-03-02 08:54:52 +01:00
<img alt="Redox" height="150" src="https://gitlab.redox-os.org/redox-os/assets/raw/master/screenshots/Senza%20titolo.jpeg">
<img alt="Redox" height="150" src="https://gitlab.redox-os.org/redox-os/assets/raw/master/screenshots/redox running.jpeg">
<img alt="Redox" height="150" src="https://gitlab.redox-os.org/redox-os/assets/raw/master/screenshots/IMG_1460.PNG">
<img alt="Redox" height="150" src="https://gitlab.redox-os.org/redox-os/assets/raw/master/screenshots/Sodium_v2.PNG">
<img alt="Redox" height="150" src="https://gitlab.redox-os.org/redox-os/assets/raw/master/screenshots/Boot.png">
<img alt="Redox" height="150" src="https://gitlab.redox-os.org/redox-os/assets/raw/master/screenshots/IMG_1459.PNG">
Big README cleanup/improvements.
2023-03-02 08:40:53 +01:00
## Getting Started
Add guidelines in the README. This commits details the guidelines for contributing to the repository.
2016-08-14 00:53:13 +02:00
Big README cleanup/improvements.
2023-03-02 08:40:53 +01:00
Please read the [Getting Started Guide](https://doc.redox-os.org/book/ch02-00-getting-started.html) in the [Redox Book](https://doc.redox-os.org/book/).
Add guidelines in the README. This commits details the guidelines for contributing to the repository.
2016-08-14 00:53:13 +02:00
Big README cleanup/improvements.
2023-03-02 08:40:53 +01:00
### Trying Out Redox
Add guidelines in the README. This commits details the guidelines for contributing to the repository.
2016-08-14 00:53:13 +02:00
Big README cleanup/improvements.
2023-03-02 08:40:53 +01:00
You can try out the Redox download in an emulator, or boot from a USB. Please see the [Getting Started Guide](https://doc.redox-os.org/book/ch02-00-getting-started.html).
### Building Redox
The Redox build system is unique and complex, so you are best to follow the practices in the book. Please see the [Getting Started Guide](https://doc.redox-os.org/book/ch02-00-getting-started.html).
### Getting Help
Please join us on [Redox Chat](https://doc.redox-os.org/book/ch13-01-chat.html) for any concerns. You can post your questions or issues in [Redox Support](https://matrix.to/#/#redox-support:matrix.org) room.
## Contributing
If you're interested in this project, and you'd like to help us out, have a look at [CONTRIBUTING](CONTRIBUTING.md).
## Ecosystem
Prepare the README for moving the kernel out. (#733) * Prepare the README for moving the kernel out. * Embolden the usernames and hyperlink them to the userpages. * Hyperlink nilset's username. * Grammar fixes, add Plan 9.
2016-11-03 16:06:24 +01:00
The ecosystem and software Redox OS provides is listed below.
Update active contributor list and add a couple of projects
2018-08-09 06:13:27 +02:00
| Name (lexicographic order) | Maintainer
|--------------------------------------------------------------------------------------|---------------------------
Rely on GitLab to link the member accounts automatically
2018-08-09 06:26:29 +02:00
| [acid (kernel integration tests)](https://gitlab.redox-os.org/redox-os/acid) | **@jackpot51** **@NilSet**
Update active contributor list and add a couple of projects
2018-08-09 06:13:27 +02:00
| [binutils](https://gitlab.redox-os.org/redox-os/binutils) | **vacant**
Rely on GitLab to link the member accounts automatically
2018-08-09 06:26:29 +02:00
| [cookbook](https://gitlab.redox-os.org/redox-os/cookbook) | **@jackpot51** **@ids1024** **@sajattack**
Update active contributor list and add a couple of projects
2018-08-09 06:13:27 +02:00
| [coreutils](https://gitlab.redox-os.org/redox-os/coreutils) | **vacant**
| [extrautils](https://gitlab.redox-os.org/redox-os/extrautils) | **vacant**
Rely on GitLab to link the member accounts automatically
2018-08-09 06:26:29 +02:00
| [games](https://gitlab.redox-os.org/redox-os/games) | **@enrico** (AKA **@HenryTheCat**) **@fabiao**
| [Ion (shell)](https://gitlab.redox-os.org/redox-os/ion) | **@mmstick** **@stratact**
Add ipcd to the list of active projects
2018-08-09 06:54:12 +02:00
| [ipcd](https://gitlab.redox-os.org/redox-os/ipcd) | **@jD91mZM2**
Rely on GitLab to link the member accounts automatically
2018-08-09 06:26:29 +02:00
| [kernel](https://gitlab.redox-os.org/redox-os/kernel) | **@jackpot51**
Update active contributor list and add a couple of projects
2018-08-09 06:13:27 +02:00
| [libextra](https://gitlab.redox-os.org/redox-os/libextra) | **vacant**
| [libpager](https://gitlab.redox-os.org/redox-os/libpager) | **vacant**
Rely on GitLab to link the member accounts automatically
2018-08-09 06:26:29 +02:00
| [netstack](https://gitlab.redox-os.org/redox-os/netstack) | **@batonius** **@dlrobertson**
| [netutils](https://gitlab.redox-os.org/redox-os/netutils) | **@jackpot51**
| [orbclient (Orbital client)](https://gitlab.redox-os.org/redox-os/orbclient) | **@jackpot51** **@FloVanGH**
| [orbdata](https://gitlab.redox-os.org/redox-os/orbdata) | **@jackpot51**
Update active contributor list and add a couple of projects
2018-08-09 06:13:27 +02:00
| [orbgame (Orbital 2D game engine)](https://gitlab.redox-os.org/redox-os/orbgame) | **@FloVanGH**
Rely on GitLab to link the member accounts automatically
2018-08-09 06:26:29 +02:00
| [Orbital (windowing and compositing system)](https://gitlab.redox-os.org/redox-os/orbital) | **@jackpot51**
Update active contributor list and add a couple of projects
2018-08-09 06:13:27 +02:00
| [orbtk (Orbital toolkit)](https://gitlab.redox-os.org/redox-os/orbtk) | **@FloVanGH**
Rely on GitLab to link the member accounts automatically
2018-08-09 06:26:29 +02:00
| [orbutils (Orbital utilities)](https://gitlab.redox-os.org/redox-os/orbutils) | **@jackpot51**
| [pkgutils (current package manager)](https://gitlab.redox-os.org/redox-os/pkgutils) | **@jackpot51**
| [ralloc](https://gitlab.redox-os.org/redox-os/ralloc) | **@Tommoa** **@NilSet**
| [RANSID (Rust ANSI driver)](https://gitlab.redox-os.org/redox-os/ransid) | **@jackpot51**
Add book maintainer, improve the build section and cleanup old stuff.
2023-02-08 20:39:27 +01:00
| [redoxfs (default filesystem)](https://gitlab.redox-os.org/redox-os/redoxfs) | **@jackpot51**
Rely on GitLab to link the member accounts automatically
2018-08-09 06:26:29 +02:00
| [relibc (C Library in Rust)](https://gitlab.redox-os.org/redox-os/relibc) | **@jD91mZM2** **@sajattack** **@Tommoa** **@stratact**
Add `small` to the project list
2018-08-09 10:17:07 +02:00
| [small (stack String and other collections)](https://gitlab.redox-os.org/redox-os/small) | **@Tommoa**
Rely on GitLab to link the member accounts automatically
2018-08-09 06:26:29 +02:00
| [syscall](https://gitlab.redox-os.org/redox-os/syscall) | **@jackpot51**
Update active contributor list and add a couple of projects
2018-08-09 06:13:27 +02:00
| [Sodium (Vim-inspired text editor)](https://gitlab.redox-os.org/redox-os/sodium) | **vacant**
Add book maintainer, improve the build section and cleanup old stuff.
2023-02-08 20:39:27 +01:00
| [The Redox book](https://gitlab.redox-os.org/redox-os/book) | **@hatred_45**
Rely on GitLab to link the member accounts automatically
2018-08-09 06:26:29 +02:00
| [userutils](https://gitlab.redox-os.org/redox-os/userutils) | **@jackpot51**
Prepare the README for moving the kernel out. (#733) * Prepare the README for moving the kernel out. * Embolden the usernames and hyperlink them to the userpages. * Hyperlink nilset's username. * Grammar fixes, add Plan 9.
2016-11-03 16:06:24 +01:00
Reference in a new issue Copy permalink