SUMMARY.md 5.18 KB
Newer Older
Ticki's avatar
Ticki committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
# 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)
Ticki's avatar
Ticki committed
17
    - [The target of Redox]()
Ticki's avatar
Ticki committed
18
19
20
21
22
23
24
25
    - [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)

Ticki's avatar
Ticki committed
26
27
-------------------------------------------------------------------------------

Ticki's avatar
Ticki committed
28
29
30
31
32
- [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?]()
Ticki's avatar
Ticki committed
33
            - [How it works under the hood](./design/url/how_it_works.md)
Ticki's avatar
Ticki committed
34
35
36
37
38
39
        - [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)
Ticki's avatar
Ticki committed
40
        - [Stitching it all together](./design/url_scheme_resource/stiching_it_all_together.md)
Ticki's avatar
Ticki committed
41
            - ["Everything is a URL"](./design/url_scheme_resource/everything_is_a_url.md)
Ticki's avatar
Ticki committed
42
            - [An example](./design/url_scheme_resource/example.md)
Ticki's avatar
Ticki committed
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
    - [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]()
Ticki's avatar
Ticki committed
97
        - [A full example]()
Ticki's avatar
Ticki committed
98
99
100
101
    - [Porting a program]()
        - [Remove dependencies]()
        - [Cross-compiling]()

Ticki's avatar
Ticki committed
102
103
-------------------------------------------------------------------------------

Ticki's avatar
Ticki committed
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
- [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]()
Ticki's avatar
Ticki committed
134
135
        - [Writing an issue]()
        - [Documenting your changes]()
Ticki's avatar
Ticki committed
136
137
138
139
140

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

Ticki's avatar
Ticki committed
141
142
-------------------------------------------------------------------------------

Ticki's avatar
Ticki committed
143
144
145
146
147
148
149
150
151
- [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]()