From f908f6e404e111120a32ef789653091fb33d2d72 Mon Sep 17 00:00:00 2001 From: Matt Baer Date: Thu, 29 Jan 2015 01:30:39 -0500 Subject: [PATCH] Explain new flags and installation --- README.md | 21 +++++++++++++++++---- 1 file changed, 17 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index ddfdba7..29ae023 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,17 @@ ~log ==== -Use **squigglelog** to easily create a simple log for your tilde. [Create new posts](https://github.com/thebaer/squigglelog/tree/master/entries#squigglelog-entries) in the `entries/` folder, then run this: +Use **squigglelog** to easily create a simple log for your tilde. + +1. Install squigglelog with `./install.sh` +2. [Create new posts](https://github.com/thebaer/squigglelog/tree/master/entries#squigglelog-entries) in the `entries/` folder, or use the `squiggle.sh` utility. +3. Generate your ~log: ```bash -go build squigglelog.go -./squigglelog -template mysquigglelog +./squigglelog -t mysquigglelog -o mylog ``` -This will use any template in `templates/` defined with _mysquigglelog_ (see below) to generate your full squigglelog page. +This will use any template in `templates/` defined with _mysquigglelog_ (see below) to generate your full squigglelog page in ~/public_html/ called mylog.html. #### templates @@ -28,3 +31,13 @@ Your template should look like this. {{end}} ``` + +There are two important lines in this file + +`{{define "mysquigglelog"}}` + +This is what you will reference in the `-t` flag passed to the generator. The template file name does not matter. + +`{{template "log" .}}` + +This must be included verbatim in your template. It will include the `templates/log.html` template, which holds all the posts.