Permalink
Browse files

Version 1.0 readme.

  • Loading branch information...
roncli committed Jan 17, 2017
1 parent 1180b0e commit dd524ee250a9617c8346178884935f0f65d6dbb4
Showing with 17 additions and 1 deletion.
  1. +17 −1 README.md
View
@@ -1,2 +1,18 @@
# ChatterGrid
An application to easily create and share custom soundboards.
An [Electron](http://electron.atom.io) application to easily create and share custom soundboards.
## Installing
To install ChatterGrid on Windows or Mac, see the [Releases](https://github.com/roncli/ChatterGrid/releases) page for platform-specific installers. For all other systems, you should run ChatterGrid from source.
## Running from Source
To run:
* Make sure you have [node.js](http://node.js) installed.
* Make sure you have [npm](https://www.npmjs.com/) installed. This should already be installed with node.js.
* From a command line, install Electron globally: `npm install -g electron`
* `cd` to the `app` directory
* Run `electron .` to launch the application.
## Releases
### 1.0 - 1/16/2017
* Initial version

0 comments on commit dd524ee

Please sign in to comment.