Add empty book

The book should eventually contain all documentation that isn't suitable
for the readme or help text.

For now it's empty, but it seemed useful to add the scaffolding, so
adding to it is low friction.

type: documentation
This commit is contained in:
Casey Rodarmor 2020-03-10 16:28:08 -07:00
parent 21a87a46f3
commit 2415d88d92
No known key found for this signature in database
GPG key ID: 556186B153EC6FE0
5 changed files with 16 additions and 1 deletions

2
.gitignore vendored
View file

@ -1,3 +1,3 @@
/target
**/*.rs.bk
notes.md
/book/book

6
book/book.toml Normal file
View file

@ -0,0 +1,6 @@
[book]
authors = ["Casey Rodarmor"]
language = "en"
multilingual = false
src = "src"
title = "imdl"

3
book/src/SUMMARY.md Normal file
View file

@ -0,0 +1,3 @@
# Summary
- [Notes](./notes.md)

1
book/src/notes.md Normal file
View file

@ -0,0 +1 @@
# Notes

View file

@ -42,12 +42,17 @@ lint:
preview-readme:
grip -b README.md
# build and serve the book
book:
mdbook serve book --open
# add git log messages to changelog
changes:
git log --pretty=format:%s >> CHANGELOG.md
dev-deps:
brew install grip
cargo install mdbook
# update readme table of contents
update-toc: