From 46434df5e8ff83fca0b5b2c65f65b5a588fe2000 Mon Sep 17 00:00:00 2001 From: TheKoopaKingdom Date: Tue, 27 Jun 2017 21:31:38 -0400 Subject: [PATCH] Added actual README. --- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/README.md b/README.md index 959a122..b1a7618 100644 --- a/README.md +++ b/README.md @@ -1 +1,22 @@ # Citra Official Website + +This repository contains the source for the [Citra Emulator](https://github.com/citra-emu/citra) website, which can be found at https://citra-emu.org/. + +## Quick Start + +### Required Tools +- [Node.js](https://nodejs.org) +- [Gulp.js](http://gulpjs.com) (Install this using the command `npm install -g gulp`, with root / admin permissions.) +- [ImageMagick](https://www.imagemagick.org) +- [GraphicsMagick](http://www.graphicsmagick.org/) + +### Instructions +1. Open up a terminal or command prompt in the `citra-web` directory. +2. Run `npm install`. +3. Run `gulp`. + +Now, Gulp should have built the Citra website, and hosted it locally. It will print out the `Access URL`s, which you can go to in your browser to view it. + +## Sitemap + +The sitemap for the Citra website can be found in [SITEMAP.md](SITEMAP.md).