Skip to content

readme.md

Latest commit

 

History

History
38 lines (24 loc) · 907 Bytes

readme.md

File metadata and controls

38 lines (24 loc) · 907 Bytes

Multi OS development setup guide

Little bit of personal documentation built with mdbook.

Operating Systems/Distros covered

Setup of an mdbook

First get Rust set up with cargo, and then run:

cargo install mdbook

and initialise a new directory for your book:

mdbook init direcctory-name

This will ask you if you want a .gitignore and what title to give the main page of your book/doc (you can change that later of course in the book.toml).

navigate into that folder and you can do:

mdbook serve

to host it live.

Usage

Place your .md files in the src folder and link them up to the SUMMARY.MD file. The title and author are set in the book.toml file.