summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNicholas Van Doorn <vandoorn.nick@gmail.com>2021-08-13 13:30:20 -0700
committerNicholas Van Doorn <vandoorn.nick@gmail.com>2021-08-13 13:32:25 -0700
commit5aed6081b4e95b296c78dbbd2d9f39337295769b (patch)
treed361e8657e35074ebfd5c70e58aaf0e7a152354c
parent62ce9d87d68681b987c9f2d0b90f303026a2f84f (diff)
Add development setup instructions
-rw-r--r--README.md27
1 files changed, 26 insertions, 1 deletions
diff --git a/README.md b/README.md
index 90f66ff..187c916 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,26 @@
-# pantry-of-plants \ No newline at end of file
+# pantry-of-plants
+
+## Development Setup
+
+We suggest using [chruby](https://github.com/postmodern/chruby) and [ruby-install](https://github.com/postmodern/ruby-install):
+
+```sh
+ruby-install ruby-$(cat .ruby-version)
+chruby $(cat .ruby-version)
+ruby --version # 2.7.4
+```
+
+Then install the required gems:
+
+```sh
+bundle install
+```
+
+and finally generate the blog!
+
+```sh
+bin/build_blog
+open output/blog.html
+```
+
+