From cf7ef596050b70f914146a9a797315cdbd396b25 Mon Sep 17 00:00:00 2001
From: Zach Bloomquist <git@chary.us>
Date: Sat, 7 May 2022 14:03:51 -0400
Subject: [PATCH] docs: add README.md

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

diff --git a/README.md b/README.md
new file mode 100644
index 00000000..f0d61592
--- /dev/null
+++ b/README.md
@@ -0,0 +1,20 @@
+This repo contains the sources for the yuzu-emu website at https://yuzu-emu.org/.
+
+# Local Development
+
+Prerequisites:
+
+* `git`
+* `yarn`
+* `graphicsmagick` (`apt install graphicsmagick` on Debian/Ubuntu)
+
+Steps to run:
+
+1. Run `git submodule init && git submodule update`.
+2. Install dependencies by running `yarn`.
+3. Set the `GITHUB_WIKI_URL` and `TENANT` enivironment variables:
+    ```
+    export GITHUB_WIKI_URL=https://github.com/yuzu-emu/yuzu.wiki.git
+    export TENANT=yuzu
+    ```
+3. Run `yarn serve` to watch files and serve on http://localhost:3000 or `yarn build` to compile a static version.