From: Ben Beltran Date: Sun, 22 Dec 2019 23:26:29 +0000 (+0100) Subject: Add a README X-Git-Url: https://git.r.bdr.sh/rbdr/forum/commitdiff_plain/1be5af9305937d4def3bf190b72e4e5450e989cb Add a README --- diff --git a/README.md b/README.md index 0ab0174..a07c14e 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,19 @@ # Forum -A forum system for the year 3000 \ No newline at end of file +A forum for the year 3000. + +## What you will need to get started + +This project uses [node][node] for most of its development processes. +Once you have node installed according to the instructions there, run +`npm install` from the root of the project. + +For local development serve the page by running `npm watch` from the +root of the project. + +## Installing git hooks + +This repo contains a pre-commit git hook so indent will run before every +commit. Run `npm run setup-hooks` to install it. + +[node]: https://nodejs.org/en/