|
1 | | -##Gmail Notifier multi-browser extension(ignotifier) |
| 1 | +## [Gmail Notifier](http://add0n.com/gmail-notifier.html) multi-browser extension (ignotifier) |
| 2 | + |
2 | 3 | ### Description |
3 | 4 | [Gmail Notifier](http://add0n.com/gmail-notifier.html) is a multi-account notifier for Google mail (without storing passwords locally) |
4 | 5 |
|
5 | | -###General information |
| 6 | + |
| 7 | + |
| 8 | +### General information |
6 | 9 | To compile ignotifier project you need to have these softwares and libraries available: |
7 | 10 |
|
8 | | - * [python](http://www.python.org/getit/) |
9 | 11 | * [nodejs](http://nodejs.org/) |
10 | | - * [Mozilla addon-sdk](https://addons.mozilla.org/en-US/developers/builder) |
11 | | - |
12 | | - |
13 | | -> By default, the addon-sdk folder is assumed to be one directory above the project. This can be modified using the ``--sdk`` parameter. |
| 12 | + * [Mozilla JPM](https://developer.mozilla.org/en-US/Add-ons/SDK/Tools/jpm) |
| 13 | + * [Gulp.JS](http://gulpjs.com/) |
14 | 14 |
|
15 | | -###Folders description |
16 | | -* compile: nodejs auto-compiler |
| 15 | +### Folders description |
| 16 | +* compile: nodejs locale converter |
17 | 17 | * preview: screenshots |
18 | 18 | * src: ignotifier source code |
19 | | -* template: bootstrap folder |
20 | 19 |
|
21 | | -###How to compile ignotifier |
| 20 | +### How to compile ignotifier |
22 | 21 | 1. Open a new terminal in the root dir (directory contains src, preview, template, and compile folders) |
23 | | -2. Run ``npm install`` to acquire the necessary nodejs packages |
24 | | -3. Run ``node compile/install.js`` to run ignotifier in a new Firefox profile |
25 | | - To make the xpi run ``node compile/install.js --xpi`` |
26 | | - For more options use ``node compile/install.js --help`` |
27 | | - |
28 | | -###How to translate ignotifier |
| 22 | +2. Run `npm install` to acquire the necessary nodejs packages |
| 23 | +3. Run `gulp firefox` or `gulp chrome` to compile ignotifier in Firefox or Chrome browsers |
| 24 | + * After running `gulp firefox`, project gets compiled for Firefox browser. Compiled files will be located on `builds/unpacked/firefox` folder. An executable XPI will be placed in `builds/packed/firefox.xpi` |
| 25 | + * After running `gulp chrome`, project gets compiled for Chrome/Opera browser. Compiled files will be located on `builds/unpacked/chrome` folder. A zipped archive will be placed in `builds/packed/chrome.zip` |
| 26 | + * For `gulp firefox` to auto install the extension on your Firefox browser, you need to have [Extension Auto-Installer](https://addons.mozilla.org/en-US/firefox/addon/autoinstaller/) installed in your Firefox. |
| 27 | + * For `gulp chrome` to auto install the extension on your Chrome browser, you will need to modify [Line 65 of `gulp.js`](https://github.com/inbasic/ignotifier/blob/master/gulpfile.js#L65) to your Chrome executable (the current path is for Mac OS). |
| 28 | + |
| 29 | +### How to translate ignotifier |
29 | 30 | * To translate ignotifier into your language head to [transifex.com](https://www.transifex.com/projects/p/gmail-notifier-addon) page. |
30 | | -* After the translation is ready, insert the translated file in `/src.safariextension/_locales` folder |
31 | | -* For Firefox to recognize the translation, you need to run the following commend in the root directory |
| 31 | +* After the translation is ready, insert the translated file in `/src/_locales` directory |
| 32 | +* For Firefox to recognize the translation, you will need to run the following commend in the root directory |
32 | 33 | `node compile/convert.js` |
33 | 34 | * Now compile the project as described above to have the localized version of ignotifier. |
34 | 35 |
|
35 | | -###How to try the precompiled latest version |
| 36 | +### How to try the precompiled latest version on Firefox |
36 | 37 | 1. Select the right branch |
37 | | -2. Browse the src directory |
| 38 | +2. Browse the `builds/packed` directory |
38 | 39 | 3. Download the raw *.xpi file |
39 | | -4. Drag and drop it into Firefox |
| 40 | +4. Open a browser tab for `about:debugging` and turn on the developer mode |
| 41 | +5. Point the browse button to the download XPI |
| 42 | + |
| 43 | +### How to try the precompiled latest version on Chrome |
| 44 | +1. Select the right branch |
| 45 | +2. Browse the `builds/packed` directory |
| 46 | +3. Download the *.zip file and extract it somewhere |
| 47 | +4. Open a browser tab for `chrome://extensions` and turn on the developer mode |
| 48 | +5. Point the browse button to the root directory |
0 commit comments