From a470de06478b39c51f9687602097dd3e228abb15 Mon Sep 17 00:00:00 2001
From: hitjim <hitjim@gmail.com>
Date: Tue, 31 Oct 2017 22:56:17 -0500
Subject: [PATCH] clarify steps for setting up development environment, added
 comments

---
 README.md | 11 ++++++++++-
 main.go   |  3 +++
 2 files changed, 13 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index d33bb0c..3b936e7 100644
--- a/README.md
+++ b/README.md
@@ -45,7 +45,16 @@ go get github.com/devict/ictgj-voting
 ```
 
 
-## Developing/Contributing Notes
+## Developing/Contributing
+### Setup
+1. Fork this repo, rather than cloning directly.
+1. Run `go get github.com/mjibson/esc`
+1. Then `go get` your github fork, similarly to the command in the Building section above.
+1. Run `go generate`
+1. Run `go build`
+1. Make and commit your changes, then submit a Pull Request (PR) through GitHub from your fork to `github.com/devict/ictgj-voting`
+
+### Notes
 * Pass in the `-dev` flag to enable development mode (load assets from the file system instead of embedded).  
 * After making changes to assets (templates, javascript, css) be sure to run `go generate` before `go build` - this regenerates the `assets.go` file  
 * Please use the go tooling to match the standard go coding style. 
diff --git a/main.go b/main.go
index 632931c..2af4f40 100644
--- a/main.go
+++ b/main.go
@@ -20,7 +20,10 @@ import (
 	"github.com/justinas/alice"
 )
 
+// AppName Application name
 const AppName = "gjvote"
+
+// DbName Database name, which is <AppName>.db
 const DbName = AppName + ".db"
 
 // pageData is stuff that changes per request