Merge pull request #11 from gambitproject/build-instructions

Add README

Author: edwardchalstrey1

README.md

@@ -0,0 +1,21 @@
+# Gambit Project website
+
+- This repository contains the source code for the Gambit Project website, which is built using Hugo and hosted on GitHub Pages.
+- View the website at https://www.gambit-project.org/
+
+
+## Developers
+
+To make changes to the website, open a pull request with your changes. The website is built using Hugo, so you can test your changes locally by doing the following:
+
+1. [Install Hugo](https://gohugo.io/installation/) on your local machine. On macOS, do not install with Homebrew directly, the latest version of Hugo is always installed and unfortunately this is not compatible with the Scientific Python theme submodule used by the website. You can instead install GO to then get the version of Hugo you need:
+    - `brew install go`
+    - `echo 'export PATH=$PATH:/Users/<username>/go/bin' >> ~/.zshrc`
+    - `go install github.com/gohugoio/hugo@v0.119.0`
+    - `export PATH=$PATH:/Users/<username>/go/bin && hugo version`
+2. Clone this repository to your local machine.
+3. Navigate to the repository directory in your terminal.
+4. Run `git submodule init` then `git submodule update` to initialise and update the theme submodule.
+    - Install the Dart Sass compiler: `npm install -g sass-embedded`, which is required by the Scientific Python Hugo theme.
+5. Run the command `hugo server --disableFastRender` to start the local development server.
+6. Open your web browser and go to `http://localhost:1313` to see your changes in action.