aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/README.md')
-rw-r--r--docs/README.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/docs/README.md b/docs/README.md
new file mode 100644
index 00000000..edfbdfff
--- /dev/null
+++ b/docs/README.md
@@ -0,0 +1,14 @@
+# Prerequisites
+```bash
+sudo apt install ruby bundler
+bundle install --path vendor/bundle
+```
+
+# Serving locally
+```bash
+bundle exec jekyll serve
+```
+
+# Theme documentation
+We are using the [just the docs](https://pmarsceill.github.io/just-the-docs/)
+theme.