Merge pull request #27 from djmitche/issue12

add an mdbook

.taskcluster.yml

@@ -44,3 +44,30 @@ tasks:
           description: Run tests for taskchampion
           owner: dustin@v.igoro.us
           source: ${repo_url}
+    - $if: run
+      then:
+        provisionerId: 'proj-misc'
+        workerType: 'ci'
+        deadline: {$fromNow: '1 hour'}
+        expires: {$fromNow: '1 day'}
+        payload:
+          maxRunTime: 3600
+          image: rust:latest
+          command:
+            - /bin/bash
+            - '-c'
+            - >-
+              git clone ${repo_url} repo &&
+              cd repo && 
+              git config advice.detachedHead false &&
+              git checkout ${ref} &&
+              cd docs &&
+              curl -L --compressed https://github.com/rust-lang/mdBook/releases/download/v0.4.4/mdbook-v0.4.4-x86_64-unknown-linux-gnu.tar.gz | gunzip -c | tar -xf - &&
+              chmod +x mdbook &&
+              ./mdbook test &&
+              ./mdbook build
+        metadata:
+          name: taskchampion-book
+          description: Verify that the docs build with mdbook
+          owner: dustin@v.igoro.us
+          source: ${repo_url}

docs/.gitignore

@@ -0,0 +1 @@
+book

docs/README.md

@@ -0,0 +1,3 @@
+This is an [mdbook](https://rust-lang.github.io/mdBook/index.html) book.
+Minor modifications can be made without installing the mdbook tool, as the content is simple Markdown.
+Changes are verified on pull requests.

docs/book.toml

@@ -0,0 +1,6 @@
+[book]
+authors = ["Dustin J. Mitchell"]
+language = "en"
+multilingual = false
+src = "src"
+title = "TaskChampion"

docs/src/SUMMARY.md

@@ -0,0 +1,6 @@
+# Summary
+
+- [Installation](./installation.md)
+- [Usage](./usage.md)
+---
+- [Development Notes](./development-notes.md)

docs/src/installation.md

@@ -0,0 +1,3 @@
+# Installation
+
+As this is currently in development, installation is by cloning the repository and running "cargo build".

docs/src/usage.md

@@ -0,0 +1,4 @@
+# Usage
+
+The main interface to your tasks is the `task` command, which supports various subcommands.
+You can find a quick list of all subcommands with `task help`.