From cc6cf63adee390cfa878e208ac32422023674aba Mon Sep 17 00:00:00 2001 From: Mark McGranaghan Date: Tue, 9 Oct 2012 07:47:56 -0700 Subject: [PATCH] formward looking readme --- .gitignore | 2 +- README.md | 16 +++++++++++++--- tool/build | 7 +++++++ 3 files changed, 21 insertions(+), 4 deletions(-) create mode 100755 tool/build diff --git a/.gitignore b/.gitignore index 378eac2..1320f90 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1 @@ -build +site diff --git a/README.md b/README.md index 1aaebc5..db58b41 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,18 @@ -## gbe-book +## gobyexample -Go by Example book source and build toolchain. +Source for the [Go by Example](https://mmcgrana.github.com/gobyexample/) +documentation project. -### Usage + +### Generation + +The web site is generated from `.go` and `.md` source +files using a custom site generator. + +Generation requires the [`pygmentize`](http://pygments.org/) +binary for syntax highlighting. + +To generate and view the site: ```console $ tool/build diff --git a/tool/build b/tool/build new file mode 100755 index 0000000..182dd4c --- /dev/null +++ b/tool/build @@ -0,0 +1,7 @@ +#!/bin/bash + +set -e + +tool/gofmt +tool/measure +tool/generate