diff --git a/README.md b/README.md new file mode 100644 index 00000000..e76163e8 --- /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: + ```bash + 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.