Skip to content

vivoblueos/book

BlueOS kernel book

This repository contains the source of "BlueOS kernel book".

Requirements

Most parts of the BlueOS project are powered by Rust programming language, including this book. Please read rustup to install native Rust toolchain to continue.

Then we are using mdBook to build this book. mdbook can be installed via command

cargo install mdbook

Build the book

To build the book, run

mdbook build -d book

To build a Chinese version of this book, please refer to mdbook-i18n-helpers first to install prerequisites. Then use command

MDBOOK_BOOK__LANGUAGE=zh mdbook build -d book/zh

The output will be in the book subdirectory. To check it out, open it in your web browser.

Firefox:

$ firefox book/index.html                       # Linux
$ open -a "Firefox" book/index.html             # OS X
$ Start-Process "firefox.exe" .\book\index.html # Windows (PowerShell)
$ start firefox.exe .\book\index.html           # Windows (Cmd)

Chrome:

$ google-chrome book/index.html                 # Linux
$ open -a "Google Chrome" book/index.html       # OS X
$ Start-Process "chrome.exe" .\book\index.html  # Windows (PowerShell)
$ start chrome.exe .\book\index.html            # Windows (Cmd)

About

No description, website, or topics provided.

Resources

License

Apache-2.0, Apache-2.0 licenses found

Licenses found

Apache-2.0
LICENSE
Apache-2.0
LICENSE.comprehensive-rust

Stars

Watchers

Forks

Packages

No packages published

Contributors 10