README.md

TiKV Development Guide

This repository contains the source of TiKV Development Guide.

Requirements

Building the book requires mdBook. To get it:

$ cargo install mdbook

Preview

To preview the book, type:

$ mdbook serve

By default, it will create a server listening on http://localhost:3000, you can open it with a brower to preview the book.

Building

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)