yeray/gobyexample
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

more tweaks

Browse Source
This commit is contained in:
Mark McGranaghan 2012-10-09 10:39:59 -07:00
parent 60e5593b8c
commit 7f128eadd8
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -13,17 +13,14 @@ This repo contains:
* `templates`: HTML templates and CSS for the site * `templates`: HTML templates and CSS for the site
* `tool`: toolchain used to generate the site * `tool`: toolchain used to generate the site
The site is built by by extracting the code & comments The site is built by extracting the code & comments from
from the .go and .sh source files in `src`, and rendering the `.go` and `.sh` source files in `src` and rendering
that data according to `meta` and `templates` via the that data according to `meta` and `templates` via programs
programs in `tool`. in `tool`.
### Usage ### Usage
Generation requires the [`pygmentize`](http://pygments.org/)
binary for syntax highlighting.
To validate the source, generate the site, and open the To validate the source, generate the site, and open the
home page in your browser: home page in your browser:
@ -32,6 +29,9 @@ $ tool/build
$ open site/index.html $ open site/index.html
``` ```
Generation requires the [`pygmentize`](http://pygments.org/)
binary for syntax highlighting.
### License ### License