Эх сурвалжийг харах

add some documentation to the README

john melesky 6 жил өмнө
parent
commit
0d1a0eba8e
1 өөрчлөгдсөн 24 нэмэгдсэн , 0 устгасан
  1. 24 0
      README.md

+ 24 - 0
README.md

@@ -1,2 +1,26 @@
 # pdorg_site
 
+
+Yeah, yeah, some documentation.
+
+This is written in Hakyll.
+
+From scratch:
+
+  - install stack (http://haskellstack.org) - any method should do, but my most recent just used `apt install haskell-stack`. It's an older version, but it works
+  - use stack to install everything, including a compiler - `stack build --install-ghc`
+    * you may have to install some dependencies. most recently, I had to `apt install libz-dev`
+  - use stack to build the site: `stack exec site build`
+  - compiled site contents are in `_site`
+
+If you add a page (blog post or whatnot):
+
+    stack exec site build
+
+If you make a change to `site.hs`:
+
+    stack build
+    stack exec site rebuild
+
+
+Honestly, you can use `rebuild` all the time if you want to, but it will be a little longer -- it deletes `_site` and builds it from scratch.