diff --git a/README.md b/README.md index 7649e31..2bc06ba 100644 --- a/README.md +++ b/README.md @@ -1,30 +1,50 @@ # Negative -Use Negative to visually compare differences between two scenes. Negative is great for web and application development, when trying to match your build to the provided comp. +> An app for making visual comparison. ![Negative Demo](negative-demo.gif) -## Shortcuts -- ⌘G - Take a screenshot -- - Move the window 1px -- ⇧← ⇧↑ ⇧→ ⇧↓ - Move the window 10px -- ⌘F - Fit window to image -- ⌘T - New tab -- ⌘} ⌘{ - Select next or previous tab -- ⌥⌘} ⌥⌘{ - Select next or previous tab + fit window to image -- ⌃⌘H - Hide or show Negative (from any app) +## User Documentation -## Build Process +- [Usage](docs/usage.md) -1. [Install Node.js](https://nodejs.org/en/) v4 or greater +## Build Negative.app + +Currently only Mac OS X is supported. + +1. [Install Node.js](https://nodejs.org/en/) v4 or v5 2. `git clone https://github.com/atdrago/negative.git` 3. `cd negative` -4. `git checkout tags/v0.6.0` +4. `npm install` 5. `npm run build` 6. Locate and copy `dist/Negative-darwin-x64/Negative.app` to your `Applications` folder -## Support -Currently only Mac OS X is supported. +## Testing + +*Important:* Tests get run against the **built app**. If you are attempting to run tests and the results are not what you expected, you need to run `npm run build` again. + +1. `npm run build` +2. `npm run test` + +## Developing + +### Compiling +- `gulp` - Compile, combine, and minify files for the renderer process. This isn't necessary for files in the main process. Make sure this is running when working on UI. + +### NPM Scripts +- `npm start` - Start the app with the following environment variables: + - NODE_ENV=development + - ELECTRON_ENABLE_LOGGING=true +- `npm run build` - Build the production app + 1. Compiles JavaScript and Sass + 2. Copies necessary files to `./release/` + 3. Runs `npm install --production` in `./release/` + 4. Builds the app moves it to `./dist/` +- `npm run lint` - Run ESLint +- `npm run test` - Run Mocha tests + +## Contributing +All contributions are welcome!! Please check [negative/issues](https://github.com/atdrago/negative/issues) for things that need attention, or feel free to create your own. Please make sure you create an issue *first*, and then do the work and a submit a PR. ## About Created by [Adam Drago](http://adamdrago.com). Icon by [Tiffany Wang](mailto:wangtiff@gmail.com). Built on [Electron](http://electron.atom.io/). diff --git a/docs/usage.md b/docs/usage.md new file mode 100644 index 0000000..8a7e883 --- /dev/null +++ b/docs/usage.md @@ -0,0 +1,16 @@ +# Negative Usage + +## Shortcuts +| Keys | Function | +|---|---| +| Command + G | Take a Screenshot | +| Arrow Keys | Move the Window 1px | +| Shift + Arrow Keys | Move the Window 10px | +| Command + F | Fit Window to Image | +| Command + T | New Tab | +| Command + W | Close Tab | +| Command + } | Next Tab | +| Command + { | Previous Tab | +| Command + Shift + } | Next Tab and Resize | +| Command + Shift + { | Previous Tab and Resize | +| Command + Control + H | Hide or show Negative (from any app) | \ No newline at end of file