From 32aae34d4bf77f4455628bd13091474d67461527 Mon Sep 17 00:00:00 2001
From: outfoxxed <outfoxxed@outfoxxed.me>
Date: Thu, 7 Mar 2024 06:18:28 -0800
Subject: [PATCH] docs: add build instructions to README

---
 README.md | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..fbd6fa0
--- /dev/null
+++ b/README.md
@@ -0,0 +1,18 @@
+# quickshell-docs
+
+Documentation for [quickshell](https://git.outfoxxed.me/outfoxxed/quickshell).
+
+# Building the documentation
+
+The docs depend on:
+- just
+- hugo
+- rust
+
+To build the documentation you must be in a subdirectory of the main quickshell repo,
+which is where the submodule clones this repo.
+
+Run the following command to build and serve the docs locally:
+```
+$ just serve
+```