docs: instructions on how to develop the docs website

projectcapsule · Nov 6, 2021 · 3d31ddb · 3d31ddb
1 parent e83f344
commit 3d31ddb
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -0,0 +1,12 @@
+# Capsule Documentation
+
+1. Ensure to have [`yarn`](https://classic.yarnpkg.com/lang/en/docs/install/#debian-stable) installed in your path.
+2. `yarn install`
+
+## Local development
+
+```shell
+yarn develop
+```
+
+This will create a local webserver listening on `localhost:8080` with hot-reload of your local changes.