# The Redox Operating-System

- [Overview](./overview/welcome.md)
    - [What Redox is](./overview/what_redox_is.md)
    - [The structure](./overview/the_structure.md)
    - [Side projects](./overview/side_projects.md)
    - [Developers](./overview/developers.md)

- [Introduction]()
    - [What is Redox?](./introduction/what_is_redox.md)
    - [Why Redox?](./introduction/why_redox.md)
    - [Why Rust?](./introduction/why_rust.md)
        - [Heartbleed: A case study]()
        - [Unsafes](./introduction/unsafes.md)
    - [Why MIT?](./introduction/why_mit.md)
    - [How Redox compares to other operating systems](./introduction/how_redox_compares_to_other_operating_systems.md)
    - [The target of Redox]()
    - [Will Redox replace Linux?](./introduction/will_redox_replace_linux.md)

- [Getting started]()
    - [Preparing Redox](./getting_started/preparing_the_build.md)
    - [Compiling Redox](./getting_started/compiling_redox.md)
    - [Exploring Redox](./getting_started/exploring_redox.md)
    - [Questions and feedback](./getting_started/asking_questions_giving_feedback.md)

-------------------------------------------------------------------------------

- [The design](./design/design.md)
    - [URLs, schemes and resources](./design/urls_schemes_resources.md)
        - [URLs](./design/url/urls.md)
            - [Aren't they weakly typed?]()
            - [Aren't they confusing?]()
            - [How it works under the hood](./design/url/how_it_works.md)
        - [Schemes](./design/scheme/schemes.md)
            - [Writing your own scheme](./design/scheme/writing_a_scheme.md)
            - [Using schemes efficiently]()
        - [Resources](./design/resource/resources.md)
            - [Socket-like](./design/resource/socket_like.md)
            - [File-like](./design/resource/file_like..md)
        - [Stitching it all together](./design/url_scheme_resource/stiching_it_all_together.md)
            - ["Everything is a URL"](./design/url_scheme_resource/everything_is_a_url.md)
            - [An example](./design/url_scheme_resource/example.md)
    - [The kernel]()
        - [Microkernels]()
            - [Advantages of microkernels]()
            - [Disadvantages of microkernels]()
            - [Performance of microkernels]()
        - [Syscalls]()
            - [Linux compatibility]()
        - [Scheduling]()
        - [Memory management]()
        - [Drivers]()
    - [Trade-offs]()
        - [Safety and performance]()
        - [Simplicity and expressiveness]()
    - [Coreutils]()
        - [Fail, fail, and fail]()
        - [Simplicty and minimalism]()
        - [Supplement utilities]()
            - [Binutils]()
            - [Extrautils]()
    - [ZFS]()
        - [What ZFS is]()
        - [The Uberblock]()
        - [RAID]()
        - [The VDev tree]()
    - [Orbital]()
        - [What Orbital is]()
        - [Orbclient]()
        - [Opening a window]()
        - [Extras]()
            - [OrbTK]()
            - [Orbutils]()
    - [Ion]()
        - [What Ion is]()
        - [The design of Ion]()
        - [The syntax]()
        - [How it differs from Bash]()
    - [Oxide]()
        - [Decentral]()
        - [Cryptography]()
        - [The indexes]()
        - [The repositories]()
        - [The trusted parties]()
    - [Sodium]()
        - [What it is]()
        - [Understanding the design]()
        - [Using Sodium efficiently]()
- [Development in userspace]()
    - [What userspace is]()
    - [Writing an application for Redox]()
        - [Platform independence]()
            - [What is available and what is not]()
        - [Using schemes]()
        - [Using Orbital]()
        - [Compiling your program]()
        - [A full example]()
    - [Porting a program]()
        - [Remove dependencies]()
        - [Cross-compiling]()

-------------------------------------------------------------------------------

- [Contributing]()
    - [Communication]()
        - [Chat]()
    - [Direct contributions]()
        - [Low hanging fruit]()
        - [Github issues]()
            - [How to do a bug report correctly]()
        - [Pull requests]()
            - [How to do a pull request properly]()
    - [Indirect contributions]()
        - [Community]()
        - [Porting your programs to Redox]()
    - [Best practices and guidelines]()
        - [Documentation]()
            - [Literal programming]()
            - [Writing docs correcty (TM)]()
            - [Marking code]()
                - [XXX]()
                - [TODO]()
                - [FIXME]()
        - [Style]()
        - [Rusting properly]()
            - [Writing fast Rust]()
            - [Avoiding heap allocations]()
            - [Exiting a program]()
            - [Avoiding panics in the kernel]()
        - [Tests]()
            - [Tests in the kernel]()
        - [Logging and assertions]()
        - [Git]()
        - [Writing an issue]()
        - [Documenting your changes]()

- [Understanding the codebase]()
    - [Kernel]()
        - [Environment]()

-------------------------------------------------------------------------------

- [Fun]()
    - [Running Redox on real hardware]()
    - [Setting up a Redox desktop]()
    - [Customizing Redox]()

- [The future]()
    - [What is done and what is not]()
    - [Goals]()
    - [Redox's target]()