yuzu-emu.github.io/README.md
Zach Bloomquist 0efc3821a2
Update README.md
Co-authored-by: liushuyu <liushuyu011@gmail.com>
2022-05-08 16:10:22 -04:00

21 lines
609 B
Markdown

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.