SUMMARY.md 6.16 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 6 7
    - [The Redox community](./overview/community.md)
			- [Side projects](./overview/side_projects.md)
			- [Projects maintainers](./overview/maintainers.md)
Ticki's avatar
Ticki committed
8 9 10 11

- [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)

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

Ticki's avatar
Ticki committed
33 34 35 36 37
- [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
38
            - [How it works under the hood](./design/url/how_it_works.md)
Ticki's avatar
Ticki committed
39
        - [Schemes](./design/scheme/schemes.md)
Ticki's avatar
Ticki committed
40
            - [The root scheme](./design/scheme/the_root_scheme.md)
Ian Douglas Scott's avatar
Ian Douglas Scott committed
41
            - [Writing your own scheme]()
Ticki's avatar
Ticki committed
42 43
            - [Using schemes efficiently]()
        - [Resources](./design/resource/resources.md)
Ian Douglas Scott's avatar
Ian Douglas Scott committed
44 45
            - [Socket-like]()
            - [File-like]()
Ticki's avatar
Ticki committed
46
        - [Stitching it all together](./design/url_scheme_resource/stiching_it_all_together.md)
Ticki's avatar
Ticki committed
47
            - ["Everything is a URL"](./design/url_scheme_resource/everything_is_a_url.md)
Ticki's avatar
Ticki committed
48
            - [An example](./design/url_scheme_resource/example.md)
Ticki's avatar
Ticki committed
49 50 51 52
    - [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
53 54 55 56 57 58 59 60 61
            - [Performance of microkernels]()
        - [Syscalls]()
            - [Linux compatibility]()
        - [Scheduling]()
        - [Memory management]()
        - [Drivers]()
    - [Trade-offs]()
        - [Safety and performance]()
        - [Simplicity and expressiveness]()
skierpage's avatar
skierpage committed
62
    - [Programs and Libraries](./design/programs_libraries.md)
63
    - [Coreutils](./design/coreutils/coreutils.md)
Ticki's avatar
Ticki committed
64 65 66
        - [Fail, fail, and fail]()
        - [Simplicty and minimalism]()
        - [Supplement utilities]()
67 68
            - [Binutils](./design/coreutils/supplement/binutils.md)
            - [Extrautils](./design/coreutils/supplement/extrautils.md)
Ticki's avatar
Ticki committed
69 70 71 72 73 74 75 76 77 78 79 80
    - [ZFS]()
        - [What ZFS is]()
        - [The Uberblock]()
        - [RAID]()
        - [The VDev tree]()
    - [Orbital]()
        - [What Orbital is]()
        - [Orbclient]()
        - [Opening a window]()
        - [Extras]()
            - [OrbTK]()
            - [Orbutils]()
81
    - [pkgutils]()
Ticki's avatar
Ticki committed
82 83 84 85
    - [Sodium]()
        - [What it is]()
        - [Understanding the design]()
        - [Using Sodium efficiently]()
Elijah Caine's avatar
Elijah Caine committed
86 87
- [Development in user space]()
    - [What user space is]()
Ticki's avatar
Ticki committed
88 89 90 91 92
    - [Writing an application for Redox]()
        - [Platform independence]()
            - [What is available and what is not]()
        - [Using schemes]()
        - [Using Orbital]()
93
        - [Compiling your program](./userspace/writing_application/compiling_program.md)
Ticki's avatar
Ticki committed
94
        - [A full example]()
Ticki's avatar
Ticki committed
95 96 97
    - [Porting a program]()
        - [Remove dependencies]()
        - [Cross-compiling]()
Martin Sehnoutka's avatar
Martin Sehnoutka committed
98 99 100 101 102
    - [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
103

104
- [Contributing](./contributing/contributing.md)
Ticki's avatar
Ticki committed
105
    - [Communication]()
106 107
        - [Chat](./contributing/communication/chat.md)
        - [Reddit](./contributing/communication/reddit.md)
Ticki's avatar
Ticki committed
108
    - [Direct contributions]()
109 110 111 112 113
        - [Low hanging fruit](./contributing/direct_contributions/low_hanging_fruit.md)
        - [Github issues](./contributing/direct_contributions/github_issues.md)
            - [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)
Ticki's avatar
Ticki committed
114
    - [Indirect contributions]()
115
        - [Community](./contributing/indirect_contributions/community.md)
Ticki's avatar
Ticki committed
116
        - [Porting your programs to Redox]()
117
    - [Best practices and guidelines](./contributing/best_practices/overview.md)
Ticki's avatar
Ticki committed
118
        - [Documentation]()
119 120
            - [Literate programming](./contributing/documentation/literate_programming.md)
            - [Writing docs correcty (TM)](./contributing/documentation/writing_docs_correctly.md)
Ticki's avatar
Ticki committed
121 122 123 124
            - [Marking code]()
                - [XXX]()
                - [TODO]()
                - [FIXME]()
125 126
        - [Style](./contributing/best_practices/style.md)
        - [Rusting properly](./contributing/best_practices/rusting_properly.md)
Ticki's avatar
Ticki committed
127 128 129
            - [Writing fast Rust]()
            - [Avoiding heap allocations]()
            - [Exiting a program]()
130
            - [Avoiding panics in the kernel](./contributing/best_practices/avoiding_kernel_panics.md)
Ticki's avatar
Ticki committed
131 132 133
        - [Tests]()
            - [Tests in the kernel]()
        - [Logging and assertions]()
134
        - [Git](./contributing/best_practices/git.md)
Ticki's avatar
Ticki committed
135 136 137 138 139 140 141 142 143 144 145 146 147 148

- [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]()