matt/squigglelog
1
0
Fork 0
mirror of https://github.com/thebaer/squigglelog synced 2018-07-20 10:45:21 +00:00
Code Issues Releases Activity

Explain new flags and installation

Browse Source
This commit is contained in:
Matt Baer 2015-01-29 01:30:39 -05:00
parent e68a82c892
commit f908f6e404
1 changed files with 17 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@ -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.
</html>
{{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.