Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
KyleBanks committed Mar 24, 2017
1 parent bf2cce7 commit 52a8e89
Showing 1 changed file with 12 additions and 7 deletions.
19 changes: 12 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,13 +21,22 @@

Goggles can be run in a web browser (cross-platform) or as a standalone application (Mac only).

### Stable
### Stable (browser & standalone)

Grab the latest release from the [Releases](https://github.com/KyleBanks/goggles/releases) page.

### From Source
### From Source (browser mode)

Regardless, there are a few steps you'll need to take in order to build and run Goggles from source:
```
$ go get github.com/KyleBanks/goggles/cmd/goggles
$ goggles
```

## Contributing

Contributions to Goggles are very welcome! In order to contribute, either open a new issue for discussion prior to making changes, or comment on an existing ticket indicating that you'd like to take it.

In order to work on Goggles there are a few steps you'll need to take in order to build and run from source:

1. `go get github.com/KyleBanks/goggles/...`
2. Install [npm](https://www.npmjs.com/) and [Gulp](http://gulpjs.com/), in order to build the front-end assets.
Expand All @@ -44,10 +53,6 @@ Regardless, there are a few steps you'll need to take in order to build and run

**Note:** If you'd like to see Goggles available as a standalone application on additional platforms, I encourage you to help contribute to the [Gallium](https://github.com/alexflint/gallium) project.

## Contributing

Contributions to Goggles are very welcome! In order to contribute, either open a new issue for discussion prior to making changes, or comment on an existing ticket indicating that you'd like to take it.

## Author

Goggles was developed by [Kyle Banks](https://twitter.com/kylewbanks).
Expand Down

0 comments on commit 52a8e89

Please sign in to comment.