Merge pull request #27 from hitjim/generated-file-cleanup

cleanup, .gitignore generated assets.go file, reflect in REAMDE.md
This commit is contained in:
Brian Buller 2017-10-13 06:31:52 -05:00 committed by GitHub
commit 3eea9e32af
3 changed files with 21 additions and 12405 deletions

3
.gitignore vendored
View File

@ -9,3 +9,6 @@ gjvote.win64.exe
# Ignore the DB
gjvote.db
# Ignore generated files
assets.go

View File

@ -1,18 +1,17 @@
# ictgj-voting
The ICT GameJam Voting Application
Downloading and Running
----
Download a binary from the list below that is appropriate for your system
Run the binary, if a database is not found in the current directory, the application will walk you through
and initial set up (create an admin user, give the site a title, name the current game jam) and a database
will be created in the current directory
## Downloading and Running
1. Download a binary from the list below that is appropriate for your system
1. Run the binary, if a database is not found in the current directory, the application will walk you through an initial set up:
1. Create an admin user
1. Give the site a title
1. Name the current game jam
1. A database will be created for you in the current directory
Command Line Arguments
----
Configuration arguments
## Command Line Arguments
### *Configuration arguments*
Passing a configuration argument will save the value to the database for future use
```none
-title=<title> Set the title for the site
@ -23,7 +22,7 @@ Passing a configuration argument will save the value to the database for future
This only affects the settings that can be set from the command line
```
Runtime Arguments
### *Runtime Arguments*
These arguments only affect the current run of the application
```none
-help Display the application help, breakdown of arguments
@ -31,8 +30,7 @@ These arguments only affect the current run of the application
rather than the binary
```
Prebuilt Binaries
----
## Prebuilt Binaries
[Linux 64 bit](https://br0xen.com/dowload/ictgj-voting/gjvote.linux64 "Linux 64 bit build")
[Linux 32 bit](https://br0xen.com/download/ictgj-voting/gjvote.linux386 "Linux 32 bit build")
[Linux Arm](https://br0xen.com/download/ictgj-voting/gjvote.linuxarm "Linux Arm build")
@ -41,26 +39,20 @@ Prebuilt Binaries
[Windows 32 bit](https://br0xen.com/download/ictgj-voting/gjvote.win386 "Windows 32 bit build")
Building
----
## Building
```none
go get github.com/devict/ictgj-voting
```
Developing/Contributing Notes
----
Do not make changes to `assets.go`, this file is generated when you run `go generate`
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. For parts that aren't bound by that style,
either try to match the already existing style, or give a reason why you think it should change.
## Developing/Contributing 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.
* For parts that aren't bound by standard go style, either try to match the already existing style, or give a reason why you think it should change.
Vendorings
----
## Vendorings
* 'boltdb' as a data store: https://github.com/boltdb/bolt
* 'boltease' to manipulate the bolt db easier: https://github.com/br0xen/boltease
* Various 'gorilla' libraries for http server stuff: https://github.com/gorilla/

12379
assets.go

File diff suppressed because it is too large Load Diff