The Machinery book

⚠ WARNING: This project is currently a work in progress.

This repository contains the source of "The Machinery" book and some other books.

How to contribute?

If you want to contribute to this project please read the CONTRIBUTING.md first!

Requirements

Building the book requires mdBook and mdbook-toc. To get it:

$ cargo install mdbook
$ cargo install mdbook-toc

Alternatively you can download the latest executables from this link and mdbook-toc.

Writing

Edit the markdown files with your editor of choice (we like Typora). If you want to see the changes live, run:

# For the_machinery_book
$ cd the_machinery_book && mdbook serve

# For the tutorials
$ cd tutorials && mdbook serve

If you want to add new pages to the system just add them to SUMMARY.md. As soon as they are in there they will be used for the book.

Building

To build the book, type:

# For the_machinery_book
$ cd the_machinery_book && mdbook build

# For the tutorials
$ cd tutorials && mdbook build

The output will appear 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)