From 4d84958ab0cb1ef5b61c67a44010d8a168794c34 Mon Sep 17 00:00:00 2001 From: Chaosvex Date: Sat, 21 Sep 2024 21:53:09 +0100 Subject: [PATCH] Expand on README --- README.md | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index cceb1fe..ebd3a04 100644 --- a/README.md +++ b/README.md @@ -1 +1,17 @@ -This is the repository for Ember's development website. +# 🔥 **Ember** + +This is the repository contains the code and content for Ember's development website, located [here](https://mmoemulator.com). The website uses [Hugo](https://gohugo.io), a static site generator. + +## Build & test locally +To build and run this website locally: +1) Follow the short installation guide on the [Hugo website](https://gohugo.io). +2) `git clone` or download this repository. +3) Navigate to the directory containing the repository. +4) Run `hugo server` (add -D to include draft content) +5) Visit http://localhost:1313 (`1313` being the default Hugo server port) + +All commits to `master` on this repository will trigger a build and deploy a new version of the website. + +## Spotted a mistake? + +Issues and pull requests are welcome.