aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/DEVELOPMENT.md
diff options
context:
space:
mode:
Diffstat (limited to 'DEVELOPMENT.md')
-rw-r--r--DEVELOPMENT.md34
1 files changed, 34 insertions, 0 deletions
diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md
new file mode 100644
index 0000000..18dfbb0
--- /dev/null
+++ b/DEVELOPMENT.md
@@ -0,0 +1,34 @@
+Workspace setup
+---------------
+
+* To reduce pain, set up [rbenv] to manage your Ruby versions.
+Install one that's known to work:
+
+ make ruby
+
+ * Otherwise, make sure you have Ruby and [Bundler] set up.
+
+* Install dependencies:
+
+ make deps
+
+* Make sure builds are working:
+
+ make build
+
+[rbenv]: https://github.com/rbenv/rbenv
+[Bundler]: https://bundler.io/
+
+Development
+-----------
+
+* Build the website and serve it at http://localhost:4000/:
+
+ make serve
+
+ * It will pick up changes and reload pages automatically.
+
+Upgrading dependencies
+----------------------
+
+ bundle update