more tweaks
This commit is contained in:
parent
60e5593b8c
commit
7f128eadd8
14
README.md
14
README.md
@ -13,17 +13,14 @@ This repo contains:
|
||||
* `templates`: HTML templates and CSS for the site
|
||||
* `tool`: toolchain used to generate the site
|
||||
|
||||
The site is built by by extracting the code & comments
|
||||
from the .go and .sh source files in `src`, and rendering
|
||||
that data according to `meta` and `templates` via the
|
||||
programs in `tool`.
|
||||
The site is built by extracting the code & comments from
|
||||
the `.go` and `.sh` source files in `src` and rendering
|
||||
that data according to `meta` and `templates` via programs
|
||||
in `tool`.
|
||||
|
||||
|
||||
### Usage
|
||||
|
||||
Generation requires the [`pygmentize`](http://pygments.org/)
|
||||
binary for syntax highlighting.
|
||||
|
||||
To validate the source, generate the site, and open the
|
||||
home page in your browser:
|
||||
|
||||
@ -32,6 +29,9 @@ $ tool/build
|
||||
$ open site/index.html
|
||||
```
|
||||
|
||||
Generation requires the [`pygmentize`](http://pygments.org/)
|
||||
binary for syntax highlighting.
|
||||
|
||||
|
||||
### License
|
||||
|
||||
|
Loading…
x
Reference in New Issue
Block a user