yuzu/yuzu-emu.github.io
1
0
Fork 0
mirror of https://github.com/yuzu-emu/yuzu-emu.github.io.git synced 2025-06-11 16:06:41 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: add README.md

Browse source
This commit is contained in:
Zach Bloomquist 2022-05-07 14:03:51 -04:00
parent a73063e81c
commit cf7ef59605
No known key found for this signature in database
GPG key ID: 6045CC844F942D74
1 changed files with 20 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
README.md Normal file
View file

@ -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.