diff --git a/README.md b/README.md index 60c1324..61db23c 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,34 @@ Various scripts and programs for the tildeverse. ## tildelog -Use **tildelog** to easily create a simple log for your tilde. +Use **tildelog** to easily create a simple log for your tilde. [Create new posts](https://github.com/thebaer/tildes/tree/master/tildelog/entries#tildelog-entries) in the `tildelog/entries/` folder, then run this: + +```bash +cd tildelog +go build tildelog.go +./tildelog -template mytildelog +``` + +This will use any template in `tildelog/templates/` defined with _mytildelog_ (see below) to generate your full tildelog page. + +#### templates + +Your template should look like this. + +```html +{{define "mytildelog"}} + +
+Welcome to my ~log.
+ {{template "log" .}} + + +{{end}} +``` ## code Use **code** to generate a list of files contained within a given directory under their home folder. This was originally made to see who had a **Code** directory (this is the default), but you can specify whatever common directory you'd like to find. Do this: