diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..9652baf --- /dev/null +++ b/README.md @@ -0,0 +1,22 @@ +# static site generator +this is my website i built using [hakyll][1] + +## copying +feel free to use it too (see `LICENSE`) but this was built for myself, it's just open source in case some one wants to see how it works. you'd be better off making your own thingy with hakyll :p + +## dependencies +GHC2021, Cabal, see `site.cabal` + +## building the executable +`hakyll` can take a while to build because of its dependency on `pandoc` but your OS might provide dynamic haskell libraries for these in its packages + +if not, be prepared to have a fierce coffee or something while you wait + +* `cabal build` - build the executable +* `cabal install` - install the executable to your $PATH + +## running the binary +all files not in `src/` are the resources used to build the website + +* `site watch` - watch the website for updates and run a local server +* `site build` - build the website |