浏览代码

docs for local viewing and deploying to site

john melesky 6 年之前
父节点
当前提交
def3ce08c4
共有 1 个文件被更改,包括 24 次插入0 次删除
  1. 24 0
      README.md

+ 24 - 0
README.md

@@ -1,6 +1,8 @@
 # pdorg_site
 
 
+## Installation
+
 Yeah, yeah, some documentation.
 
 This is written in Hakyll.
@@ -24,3 +26,25 @@ If you make a change to `site.hs`:
 
 
 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.
+
+
+## Running locally
+
+All you need is `stack exec site watch`.
+
+## Deploying
+
+On the current Rimu VM (as of mid-2018):
+
+    cd code/pdorg_site
+    git pull; stack exec site rebuild
+
+As above, if you make a change to the `site.hs`, you'll instead want:
+
+    cd code/pdorg_site
+    git pull
+    stack build
+    stack exec site rebuild
+
+
+