Merge pull request #87 from zcash/book-skeleton

Book skeleton

.github/workflows/book.yml

@@ -0,0 +1,26 @@
+name: halo2 book
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  deploy:
+    runs-on: ubuntu-18.04
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Setup mdBook
+        uses: peaceiris/actions-mdbook@v1
+        with:
+          mdbook-version: '0.4.4'
+
+      - name: Build halo2 book
+        run: mdbook build book/
+
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./book/book

.github/workflows/ci.yml

@@ -64,6 +64,18 @@ jobs:
           command: build
           args: --all --benches --all-features
 
+  book:
+    name: Book tests
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Setup mdBook
+        uses: peaceiris/actions-mdbook@v1
+        with:
+          mdbook-version: '0.4.4'
+      - name: Test halo2 book
+        run: mdbook test book/
+
   clippy:
     name: Clippy (stable)
     timeout-minutes: 30

book/.gitignore

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

book/book.toml

@@ -0,0 +1,6 @@
+[book]
+authors = ["Jack Grigg"]
+language = "en"
+multilingual = false
+src = "src"
+title = "The halo2 Book"

book/src/README.md

@@ -0,0 +1 @@
+{{#include ../../README.md}}

book/src/SUMMARY.md

@@ -0,0 +1,7 @@
+# The halo2 Book
+
+[halo2](README.md)
+- [Concepts](concepts.md)
+- [User Documentation](user.md)
+  - [Gadgets](user/gadgets.md)
+- [Design](design.md)

book/src/concepts.md

@@ -0,0 +1 @@
+# Concepts

book/src/design.md

@@ -0,0 +1 @@
+# Design

book/src/user.md

@@ -0,0 +1 @@
+# User Documentation

book/src/user/gadgets.md

@@ -0,0 +1 @@
+# Gadgets