SUMMARY.md 5.8 KB
Newer Older
Ticki's avatar
Ticki committed
1
2
3
4
5
6
7
8
9
10
11
# 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)
Jeremy Soller's avatar
Jeremy Soller committed
12
    - [Why Free Software?](./introduction/why_free_software.md)
Ticki's avatar
Ticki committed
13
14
15
16
    - [Why Rust?](./introduction/why_rust.md)
        - [Heartbleed: A case study]()
        - [Unsafes](./introduction/unsafes.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
    - [Will Redox replace Linux?](./introduction/will_redox_replace_linux.md)
Elijah Caine's avatar
Elijah Caine committed
19
    - [About this Book](./introduction/about_this_book.md)
Ticki's avatar
Ticki committed
20
21
22
23
24
25
26

- [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
27
28
-------------------------------------------------------------------------------

29
30
31
- [Exploring Redox](./explore/explore.md)
    - [Boot Process](./explore/boot_process.md)
    - [Shell](./explore/shell.md)
Ian Douglas Scott's avatar
Ian Douglas Scott committed
32
    - [Utilities]()
33
34
35
36
    - [GUI](./explore/gui.md)

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

Ticki's avatar
Ticki committed
37
38
39
40
41
- [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
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)
Ian Douglas Scott's avatar
Ian Douglas Scott committed
45
            - [Writing your own scheme]()
Ticki's avatar
Ticki committed
46
47
            - [Using schemes efficiently]()
        - [Resources](./design/resource/resources.md)
Ian Douglas Scott's avatar
Ian Douglas Scott 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)
Ticki's avatar
Ticki committed
57
58
59
60
61
62
63
64
65
            - [Performance of microkernels]()
        - [Syscalls]()
            - [Linux compatibility]()
        - [Scheduling]()
        - [Memory management]()
        - [Drivers]()
    - [Trade-offs]()
        - [Safety and performance]()
        - [Simplicity and expressiveness]()
66
    - [Coreutils](./design/coreutils/coreutils.md)
Ticki's avatar
Ticki committed
67
68
69
        - [Fail, fail, and fail]()
        - [Simplicty and minimalism]()
        - [Supplement utilities]()
70
71
            - [Binutils](./design/coreutils/supplement/binutils.md)
            - [Extrautils](./design/coreutils/supplement/extrautils.md)
Ticki's avatar
Ticki committed
72
73
74
75
76
77
78
79
80
81
82
83
    - [ZFS]()
        - [What ZFS is]()
        - [The Uberblock]()
        - [RAID]()
        - [The VDev tree]()
    - [Orbital]()
        - [What Orbital is]()
        - [Orbclient]()
        - [Opening a window]()
        - [Extras]()
            - [OrbTK]()
            - [Orbutils]()
84
    - [Magnet]()
Ticki's avatar
Ticki committed
85
86
87
88
89
90
91
92
93
        - [Decentral]()
        - [Cryptography]()
        - [The indexes]()
        - [The repositories]()
        - [The trusted parties]()
    - [Sodium]()
        - [What it is]()
        - [Understanding the design]()
        - [Using Sodium efficiently]()
Elijah Caine's avatar
Elijah Caine committed
94
95
- [Development in user space]()
    - [What user space is]()
Ticki's avatar
Ticki committed
96
97
98
99
100
101
    - [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
102
        - [A full example]()
Ticki's avatar
Ticki committed
103
104
105
    - [Porting a program]()
        - [Remove dependencies]()
        - [Cross-compiling]()
Martin Sehnoutka's avatar
Martin Sehnoutka committed
106
107
108
109
110
    - [Ion](./userspace/ion/ion.md)
        - [What Ion is](./userspace/ion/what_ion_is.md)
        - [The design of Ion]()
        - [The syntax](./userspace/ion/the_syntax.md)
        - [How it differs from Bash]()
Ticki's avatar
Ticki committed
111

Ticki's avatar
Ticki committed
112
113
-------------------------------------------------------------------------------

Ticki's avatar
Ticki committed
114
115
- [Contributing]()
    - [Communication]()
cvrt's avatar
cvrt committed
116
        - [Chat](./contributing/chat.md)
Ticki's avatar
Ticki committed
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
    - [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
144
145
        - [Writing an issue]()
        - [Documenting your changes]()
Ticki's avatar
Ticki committed
146
147
148
149
150

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

Ticki's avatar
Ticki committed
151
152
-------------------------------------------------------------------------------

Ticki's avatar
Ticki committed
153
154
155
156
157
158
159
160
161
- [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]()