SUMMARY.md 7.14 KB
Newer Older
Ticki's avatar
Ticki committed
1 2 3 4
# The Redox Operating-System

- [Overview](./overview/welcome.md)
    - [What Redox is](./overview/what_redox_is.md)
k0pernicus's avatar
k0pernicus committed
5
    - [The Redox community](./overview/community.md)
Dan Robertson's avatar
Dan Robertson committed
6 7
        - [Side projects](./overview/side_projects.md)
        - [Projects maintainers](./overview/maintainers.md)
Ticki's avatar
Ticki committed
8

Dan Robertson's avatar
Dan Robertson committed
9
- [Introduction](./introduction/index.md)
Ticki's avatar
Ticki committed
10 11
    - [What is Redox?](./introduction/what_is_redox.md)
    - [Why Redox?](./introduction/why_redox.md)
Jeremy Soller's avatar
Jeremy Soller committed
12
    - [Why Free Software?](./introduction/why_free_software.md)
Ticki's avatar
Ticki committed
13
    - [Why Rust?](./introduction/why_rust.md)
Dan Robertson's avatar
Dan Robertson committed
14
[//]: # (        - [Heartbleed: A case study]())
Ticki's avatar
Ticki committed
15 16
        - [Unsafes](./introduction/unsafes.md)
    - [How Redox compares to other operating systems](./introduction/how_redox_compares_to_other_operating_systems.md)
Dan Robertson's avatar
Dan Robertson committed
17
[//]: # (    - [The target of Redox]())
Ticki's avatar
Ticki committed
18
    - [Will Redox replace Linux?](./introduction/will_redox_replace_linux.md)
19
    - [About this Book](./introduction/about_this_book.md)
Ticki's avatar
Ticki committed
20

21 22 23
- [Getting started](./getting_started/getting_started.md)
    - [Trying Redox in a virtual machine](./getting_started/try_vm.md)
    - [Running Redox on real hardware](./getting_started/real_hardware.md)
24
    - [Installing the toolchain](./getting_started/installing_the_toolchain.md)
25
    - [Preparing the build](./getting_started/preparing_the_build.md)
Ticki's avatar
Ticki committed
26 27 28 29
    - [Compiling Redox](./getting_started/compiling_redox.md)
    - [Exploring Redox](./getting_started/exploring_redox.md)
    - [Questions and feedback](./getting_started/asking_questions_giving_feedback.md)

30 31 32
- [Exploring Redox](./explore/explore.md)
    - [Boot Process](./explore/boot_process.md)
    - [Shell](./explore/shell.md)
Dan Robertson's avatar
Dan Robertson committed
33
[//]: # (    - [Utilities]())
34 35
    - [GUI](./explore/gui.md)

Ticki's avatar
Ticki committed
36
- [The design](./design/design.md)
37
    - [Components](./design/components.md)
Ticki's avatar
Ticki committed
38 39
    - [URLs, schemes and resources](./design/urls_schemes_resources.md)
        - [URLs](./design/url/urls.md)
Dan Robertson's avatar
Dan Robertson committed
40 41
[//]: # (            - [Aren't they weakly typed?]())
[//]: # (            - [Aren't they confusing?]())
Ticki's avatar
Ticki committed
42
            - [How it works under the hood](./design/url/how_it_works.md)
Ticki's avatar
Ticki committed
43
        - [Schemes](./design/scheme/schemes.md)
Ticki's avatar
Ticki committed
44
            - [The root scheme](./design/scheme/the_root_scheme.md)
Dan Robertson's avatar
Dan Robertson committed
45 46
[//]: # (            - [Writing your own scheme]())
[//]: # (            - [Using schemes efficiently]())
Ticki's avatar
Ticki committed
47
        - [Resources](./design/resource/resources.md)
Dan Robertson's avatar
Dan Robertson committed
48 49
[//]: # (            - [Socket-like]())
[//]: # (            - [File-like]())
Ticki's avatar
Ticki committed
50
        - [Stitching it all together](./design/url_scheme_resource/stiching_it_all_together.md)
Ticki's avatar
Ticki committed
51
            - ["Everything is a URL"](./design/url_scheme_resource/everything_is_a_url.md)
Ticki's avatar
Ticki committed
52
            - [An example](./design/url_scheme_resource/example.md)
Ticki's avatar
Ticki committed
53 54 55 56
    - [The kernel](./design/kernel/kernel.md)
        - [Microkernels](./design/kernel/microkernels.md)
            - [Advantages of microkernels](./design/kernel/advantages.md)
            - [Disadvantages of microkernels](./design/kernel/disadvantages.md)
Dan Robertson's avatar
Dan Robertson committed
57 58 59 60 61 62 63 64 65
[//]: # (            - [Performance of microkernels]())
[//]: # (        - [Syscalls]())
[//]: # (            - [Linux compatibility]())
        - [Scheduling](./design/scheduling)
        - [Memory management](./design/memory)
        - [Drivers](./design/drivers)
[//]: # (    - [Trade-offs]())
[//]: # (        - [Safety and performance]())
[//]: # (        - [Simplicity and expressiveness]())
66
    - [Programs and Libraries](./design/programs_libraries.md)
67
    - [Coreutils](./design/coreutils/coreutils.md)
Dan Robertson's avatar
Dan Robertson committed
68 69 70
[//]: # (        - [Fail, fail, and fail]())
[//]: # (        - [Simplicty and minimalism]())
        - [Supplement utilities](./design/coreutils/supplement/index.md)
71 72
            - [Binutils](./design/coreutils/supplement/binutils.md)
            - [Extrautils](./design/coreutils/supplement/extrautils.md)
Dan Robertson's avatar
Dan Robertson committed
73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91
[//]: # (    - [Orbital]())
[//]: # (        - [What Orbital is]())
[//]: # (        - [Orbclient]())
[//]: # (        - [Opening a window]())
[//]: # (        - [Extras]())
[//]: # (            - [OrbTK]())
[//]: # (            - [Orbutils]())
[//]: # (    - [pkgutils]())
[//]: # (    - [Sodium]())
[//]: # (        - [What it is]())
[//]: # (        - [Understanding the design]())
[//]: # (        - [Using Sodium efficiently]())
- [Development in user space](./userspace/index.md)
[//]: # (    - [What user space is]())
    - [Writing an application for Redox](./userspace/writing_application/index.md)
[//]: # (        - [Platform independence]())
[//]: # (            - [What is available and what is not]())
[//]: # (        - [Using schemes]())
[//]: # (        - [Using Orbital]())
92
        - [Compiling your program](./userspace/writing_application/compiling_program.md)
Dan Robertson's avatar
Dan Robertson committed
93 94 95 96
[//]: # (        - [A full example]())
[//]: # (    - [Porting a program]())
[//]: # (        - [Remove dependencies]())
[//]: # (        - [Cross-compiling]())
Martin Sehnoutka's avatar
Martin Sehnoutka committed
97 98
    - [Ion](./userspace/ion/ion.md)
        - [What Ion is](./userspace/ion/what_ion_is.md)
Paul Sajna's avatar
Paul Sajna committed
99
        - [The Manual](./userspace/ion/the_manual.md)
Ticki's avatar
Ticki committed
100

101
- [Contributing](./contributing/contributing.md)
Dan Robertson's avatar
Dan Robertson committed
102
    - [Communication](./contributing/communication/index.md)
103 104
        - [Chat](./contributing/communication/chat.md)
        - [Reddit](./contributing/communication/reddit.md)
Dan Robertson's avatar
Dan Robertson committed
105
    - [Direct contributions](./contributing/direct_contributions/index.md)
106
        - [Low hanging fruit](./contributing/direct_contributions/low_hanging_fruit.md)
107
        - [GitLab issues](./contributing/direct_contributions/gitlab_issues.md)
108 109 110
            - [How to do a bug report correctly](./contributing/direct_contributions/creating_proper_bug_reports.md)
        - [Pull requests](./contributing/direct_contributions/pull_requests.md)
            - [How to do a pull request properly](./contributing/direct_contributions/creating_proper_pull_requests.md)
Dan Robertson's avatar
Dan Robertson committed
111 112
[//]: # (TODO FIX THIS)
[//]: # (    - [Indirect contributions]())
113
        - [Community](./contributing/indirect_contributions/community.md)
Dan Robertson's avatar
Dan Robertson committed
114
[//]: # (        - [Porting your programs to Redox]())
115
    - [Best practices and guidelines](./contributing/best_practices/overview.md)
Dan Robertson's avatar
Dan Robertson committed
116 117
[//]: # (TODO FIX THIS)
[//]: # (        - [Documentation]())
118 119
            - [Literate programming](./contributing/documentation/literate_programming.md)
            - [Writing docs correcty (TM)](./contributing/documentation/writing_docs_correctly.md)
Dan Robertson's avatar
Dan Robertson committed
120 121 122 123
[//]: # (            - [Marking code]())
[//]: # (                - [XXX]())
[//]: # (                - [TODO]())
[//]: # (                - [FIXME]())
124 125
        - [Style](./contributing/best_practices/style.md)
        - [Rusting properly](./contributing/best_practices/rusting_properly.md)
Dan Robertson's avatar
Dan Robertson committed
126 127 128
[//]: # (            - [Writing fast Rust]())
[//]: # (            - [Avoiding heap allocations]())
[//]: # (            - [Exiting a program]())
129
            - [Avoiding panics in the kernel](./contributing/best_practices/avoiding_kernel_panics.md)
Dan Robertson's avatar
Dan Robertson committed
130 131 132
[//]: # (        - [Tests]())
[//]: # (            - [Tests in the kernel]())
[//]: # (        - [Logging and assertions]())
133
        - [Git](./contributing/best_practices/git.md)
Dan Robertson's avatar
Dan Robertson committed
134 135 136 137 138 139 140 141 142 143
[//]: # (- [Understanding the codebase]())
[//]: # (    - [Kernel]())
[//]: # (        - [Environment]())
[//]: # (- [Fun]())
[//]: # (    - [Setting up a Redox desktop]())
[//]: # (    - [Customizing Redox]())
[//]: # (- [The future]())
[//]: # (    - [What is done and what is not]())
[//]: # (    - [Goals]())
[//]: # (    - [Redox's target]())