1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27

#![feature(external_doc)]
#![deny(intra_doc_link_resolution_failure)]

#![doc(include = "../README.md")]

fn main() {}

pub mod building {
    #![doc(include = "../BUILDING.md")]
}
pub mod updating_rust_version {
    #![doc(include = "../UPDATE_RUST.md")]
}

pub mod security_architecture {
    #![doc(include = "../SECURITY_ARCHITECTURE.md")]
}

// TODO: Add design goals documentation.
// BODY: Add documentation about the design goals of SunriseOS.
// BODY: This should include:
// BODY:
// BODY: - Simple to build
// BODY:   - Requires only a rust toolchain that can be installed straight from rustup
// BODY: - Simple to install
// BODY: - Every piece should be documented such that an outsider may understand what we're up to.
// BODY: - Only support modern hardware