usrtax / vBook

The vSMTP reference book

vBook - The vSMTP reference book

This repository contains the source of vBook, the vSMTP reference guide. It serves as vSMTP's primary documentation and tutorial resource.

You can also read the book online for vSMTP stable and beta releases. Be aware that issues in those versions may have been fixed in this repository already, as those releases are updated less frequently.

Requirements

Building the book requires Rust and mdBook. The Rust Language runs on many platforms, and there are many ways to install it. If you want to install Rust in the most straightforward, recommended way, then use Rustup and/or follow the instructions on the Rust website installation page.

Then you have to install mdBook. To get it:

cargo install mdbook

Building the book

To build the book, type:

mdbook build

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)

Contributing

We'd love your help! Please see the CONTRIBUTING file to learn about the kinds of contributions we're looking for.

Licensing

vBook, vBook files and this repository are licensed under a Creative Commons Attribution-ShareAlike 4.0 International License. For further details please refer to the LICENSE file.