diff --git a/README.md b/README.md index 8a9b8fd..95744c9 100644 --- a/README.md +++ b/README.md @@ -9,10 +9,15 @@ I'm fairly new to Rust and had learned Golang a few months ago, so prefered tryi With some hope (and luck), this might eventually become the live version of the game. ## Development +### Setup 1. Install [Golang 1.12.9](https://golang.org/) or later -2. Clone `reference.pxls.conf`, rename it to `pxls.conf` and configure to your liking -3. Run `go run src/*` -4. Go to [https://localhost:4567](https://localhost:4567) (or whatever port you configured in `pxls.conf`) +2. Clone this repository and `cd` to it +3. Run `go mod download` to install dependencies +4. Clone `reference.pxls.conf`, rename it to `pxls.conf` and configure to your liking + +### For running +5. Run `go run src/*` +6. Go to [https://localhost:4567](https://localhost:4567) (or whatever port you configured in `pxls.conf`) ## Implemented