Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tikv/tikv-dev-guide
The TiKV development/contribution guide
https://github.com/tikv/tikv-dev-guide
development guide tikv
Last synced: 24 days ago
JSON representation
The TiKV development/contribution guide
- Host: GitHub
- URL: https://github.com/tikv/tikv-dev-guide
- Owner: tikv
- License: apache-2.0
- Created: 2021-07-21T05:25:01.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-07-20T03:12:45.000Z (over 2 years ago)
- Last Synced: 2024-11-10T02:43:15.208Z (3 months ago)
- Topics: development, guide, tikv
- Homepage: https://tikv.github.io/tikv-dev-guide/
- Size: 2.11 MB
- Stars: 34
- Watchers: 15
- Forks: 12
- Open Issues: 37
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# TiKV Development Guide
This repository contains the source of TiKV Development Guide.
## Requirements
Building the book requires [mdBook](https://github.com/rust-lang-nursery/mdBook). To get it:
```bash
$ cargo install mdbook
```
## Preview
To preview the book, type:
```bash
$ mdbook serve
```
By default, it will create a server listening on [http://localhost:3000](http://localhost:3000), you can open it with a brower to preview the book.
## Building
To build the book, type:
```bash
$ mdbook build
```
The output will be in the `book` subdirectory. To check it out, open it in
your web browser.
_Firefox:_
```bash
$ 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:_
```bash
$ 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)
```