mirror of
https://github.com/hinto-janai/cuprate.git
synced 2024-11-16 15:58:14 +00:00
books: add user-book
template (#154)
* add user-book * add `A-book-user` to labeler
This commit is contained in:
parent
0e5555d4d4
commit
e0736d1807
6 changed files with 37 additions and 3 deletions
4
.github/labeler.yml
vendored
4
.github/labeler.yml
vendored
|
@ -43,6 +43,10 @@ A-book-protocol:
|
||||||
- changed-files:
|
- changed-files:
|
||||||
- any-glob-to-any-file: books/protocol/**
|
- any-glob-to-any-file: books/protocol/**
|
||||||
|
|
||||||
|
A-book-user:
|
||||||
|
- changed-files:
|
||||||
|
- any-glob-to-any-file: books/user/**
|
||||||
|
|
||||||
# Crate (sub-)directories.
|
# Crate (sub-)directories.
|
||||||
A-binaries:
|
A-binaries:
|
||||||
- changed-files:
|
- changed-files:
|
||||||
|
|
|
@ -4,6 +4,7 @@ This directory contains the source files for Cuprate's various books.
|
||||||
The source files are edited here, and published in other repositories, see:
|
The source files are edited here, and published in other repositories, see:
|
||||||
- [Cuprate's architecture book](https://github.com/Cuprate/architecture-book)
|
- [Cuprate's architecture book](https://github.com/Cuprate/architecture-book)
|
||||||
- [Cuprate's protocol book](https://github.com/Cuprate/monero-book)
|
- [Cuprate's protocol book](https://github.com/Cuprate/monero-book)
|
||||||
|
- [Cuprate's user book](https://github.com/Cuprate/user-book)
|
||||||
|
|
||||||
## Build tools
|
## Build tools
|
||||||
Building the book(s) requires [Rust's cargo tool](https://doc.rust-lang.org/cargo/getting-started/installation.html) and [mdBook](https://github.com/rust-lang/mdBook).
|
Building the book(s) requires [Rust's cargo tool](https://doc.rust-lang.org/cargo/getting-started/installation.html) and [mdBook](https://github.com/rust-lang/mdBook).
|
||||||
|
@ -17,12 +18,12 @@ cargo install mdbook
|
||||||
To build a book, go into a book's directory and build:
|
To build a book, go into a book's directory and build:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# This build Cuprate's architecture book.
|
# This build Cuprate's user book.
|
||||||
cd architecture/
|
cd user/
|
||||||
mdbook build
|
mdbook build
|
||||||
```
|
```
|
||||||
|
|
||||||
The output will be in the `book` subdirectory (`architecture/book` for the above example). To open the book, you can open it in your web browser like so:
|
The output will be in the `book` subdirectory (`user/book` for the above example). To open the book, you can open it in your web browser like so:
|
||||||
```bash
|
```bash
|
||||||
mdbook build --open
|
mdbook build --open
|
||||||
```
|
```
|
||||||
|
|
6
books/user/README.md
Normal file
6
books/user/README.md
Normal file
|
@ -0,0 +1,6 @@
|
||||||
|
## Cuprate's user book
|
||||||
|
This book is the end-user documentation for Cuprate, aka, "how to use `cuprated`".
|
||||||
|
|
||||||
|
See:
|
||||||
|
- <https://user.cuprate.org>
|
||||||
|
- <https://github.com/Cuprate/user-book>
|
19
books/user/book.toml
Normal file
19
books/user/book.toml
Normal file
|
@ -0,0 +1,19 @@
|
||||||
|
[book]
|
||||||
|
authors = ["hinto-janai"]
|
||||||
|
language = "en"
|
||||||
|
multilingual = false
|
||||||
|
src = "src"
|
||||||
|
title = "Cuprate's user book"
|
||||||
|
git-repository-url = "https://github.com/Cuprate/user-book"
|
||||||
|
|
||||||
|
# TODO: fix after importing real files.
|
||||||
|
#
|
||||||
|
# [preprocessor.last-changed]
|
||||||
|
# command = "mdbook-last-changed"
|
||||||
|
# renderer = ["html"]
|
||||||
|
#
|
||||||
|
# [output.html]
|
||||||
|
# default-theme = "ayu"
|
||||||
|
# preferred-dark-theme = "ayu"
|
||||||
|
# git-repository-url = "https://github.com/hinto-janai/cuprate-user"
|
||||||
|
# additional-css = ["last-changed.css"]
|
3
books/user/src/SUMMARY.md
Normal file
3
books/user/src/SUMMARY.md
Normal file
|
@ -0,0 +1,3 @@
|
||||||
|
# Summary
|
||||||
|
|
||||||
|
- [TODO](todo.md)
|
1
books/user/src/todo.md
Normal file
1
books/user/src/todo.md
Normal file
|
@ -0,0 +1 @@
|
||||||
|
# TODO
|
Loading…
Reference in a new issue