From 5c57a81b08bb6c7e5cb6b5698d1d125acb473810 Mon Sep 17 00:00:00 2001 From: Adam Drago Date: Mon, 18 Apr 2016 07:23:31 -0700 Subject: [PATCH 1/6] Remove support section. Add "Making changes locally" section --- README.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 7649e31..04ecb9e 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # 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) @@ -14,7 +14,9 @@ Use Negative to visually compare differences between two scenes. Negative is gre - ⌥⌘} ⌥⌘{ - Select next or previous tab + fit window to image - ⌃⌘H - Hide or show Negative (from any app) -## Build Process +## Build Negative.app + +Currently only Mac OS X is supported. 1. [Install Node.js](https://nodejs.org/en/) v4 or greater 2. `git clone https://github.com/atdrago/negative.git` @@ -23,8 +25,9 @@ Use Negative to visually compare differences between two scenes. Negative is gre 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. +## Making changes locally +- `gulp` - Files in the renderer process are combined and minified, so you'll need to be running gulp to see your changes. This isn't necessary for files in the main process. +- `npm start` - This opens the app. ## About Created by [Adam Drago](http://adamdrago.com). Icon by [Tiffany Wang](mailto:wangtiff@gmail.com). Built on [Electron](http://electron.atom.io/). From 484a5e417d6e2b00073f2a33ff35f158a4e14228 Mon Sep 17 00:00:00 2001 From: Adam Drago Date: Tue, 26 Apr 2016 09:26:20 -0700 Subject: [PATCH 2/6] Add "recommended" to build step 4 --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 04ecb9e..df794ca 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,7 @@ Currently only Mac OS X is supported. 1. [Install Node.js](https://nodejs.org/en/) v4 or greater 2. `git clone https://github.com/atdrago/negative.git` 3. `cd negative` -4. `git checkout tags/v0.6.0` +4. `git checkout tags/v0.6.0` (*recommended*) 5. `npm run build` 6. Locate and copy `dist/Negative-darwin-x64/Negative.app` to your `Applications` folder From c55b4428d263f8556e818ac452d76e085380023d Mon Sep 17 00:00:00 2001 From: Adam Drago Date: Tue, 10 May 2016 17:43:32 -0700 Subject: [PATCH 3/6] Update "Building Negative" to specify proper node version, add `npm install`, and remove tag checkout. Add "Testing" section. --- README.md | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index df794ca..efad4e7 100644 --- a/README.md +++ b/README.md @@ -18,14 +18,22 @@ Currently only Mac OS X is supported. -1. [Install Node.js](https://nodejs.org/en/) v4 or greater +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` (*recommended*) +4. `npm install` 5. `npm run build` 6. Locate and copy `dist/Negative-darwin-x64/Negative.app` to your `Applications` folder -## Making changes locally +## Testing + +*Important:* Tests gets 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 + - `gulp` - Files in the renderer process are combined and minified, so you'll need to be running gulp to see your changes. This isn't necessary for files in the main process. - `npm start` - This opens the app. From fa8d0b91d59bfad3231bda780f1eb77ee8ea2360 Mon Sep 17 00:00:00 2001 From: Adam Drago Date: Tue, 10 May 2016 19:23:39 -0700 Subject: [PATCH 4/6] Move Usage to `docs/usage.md` --- README.md | 12 +++--------- docs/usage.md | 16 ++++++++++++++++ 2 files changed, 19 insertions(+), 9 deletions(-) create mode 100644 docs/usage.md diff --git a/README.md b/README.md index efad4e7..b023289 100644 --- a/README.md +++ b/README.md @@ -4,15 +4,9 @@ ![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) +## Documentation + +- [Usage](docs/usage.md) ## Build Negative.app 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 From 451d73a01df8bcbdb8c1b831cbb7f2ab05a48a00 Mon Sep 17 00:00:00 2001 From: Adam Drago Date: Tue, 10 May 2016 23:06:29 -0700 Subject: [PATCH 5/6] Add "Compiling" and "NPM Scripts" sections below "Developing". Add "Contributing" section. --- README.md | 21 ++++++++++++++++++--- 1 file changed, 18 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index b023289..854407f 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ ![Negative Demo](negative-demo.gif) -## Documentation +## User Documentation - [Usage](docs/usage.md) @@ -28,8 +28,23 @@ Currently only Mac OS X is supported. ## Developing -- `gulp` - Files in the renderer process are combined and minified, so you'll need to be running gulp to see your changes. This isn't necessary for files in the main process. -- `npm start` - This opens the app. +### Compiling +- `gulp` - Compile, combine, and minify files for the renderer process. This isn't necessary for files in the main process. + +### 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/). From 2aeea409be9d6203215ac5a79fc5eeead4600f24 Mon Sep 17 00:00:00 2001 From: Adam Drago Date: Tue, 10 May 2016 23:09:50 -0700 Subject: [PATCH 6/6] Fix typos. --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 854407f..2bc06ba 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,7 @@ Currently only Mac OS X is supported. ## Testing -*Important:* Tests gets 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. +*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` @@ -29,7 +29,7 @@ Currently only Mac OS X is supported. ## Developing ### Compiling -- `gulp` - Compile, combine, and minify files for the renderer process. This isn't necessary for files in the main process. +- `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: