From 3685f7cc97d7a028c2154e961faa3c89902d8071 Mon Sep 17 00:00:00 2001
From: Gabriele Musco <gabmus@disroot.org>
Date: Mon, 4 Dec 2023 23:27:32 +0100
Subject: [PATCH] chore: readme with instructions

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..3062cf4
--- /dev/null
+++ b/README.md
@@ -0,0 +1,40 @@
+# Linux VR Adventures Wiki
+
+The Linux VR knowledge base!
+
+---
+
+## Requirements
+
+You will need to install [Hugo extended](https://gohugo.io/installation/linux/).
+
+### Cloning and submodules
+
+You'll need to clone this repo with submodules or init your submodules after the fact.
+
+#### Clone with submodules
+
+```bash
+git clone https://gitlab.com/LVRA/wiki --recurse-submodules
+```
+
+#### Init submodules in existing clone
+
+```bash
+git submodule init
+git submodule update
+```
+
+## Running
+
+You can run a live server with
+
+```bash
+hugo serve
+```
+
+## Building
+
+```bash
+hugo
+```