blinker / firefox.plugin / README.md @ master
History | View | Annotate | Download (1.271 KB)
| 1 | a03cd52e | Thies Pfeiffer | Blinker |
|---|---|---|---|
| 2 | ======= |
||
| 3 | |||
| 4 | [Download](https://opensource.cit-ec.de/projects/gazetk/repository/blinker) |
||
| 5 | |||
| 6 | License |
||
| 7 | ------- |
||
| 8 | Blinker is free and open source software distributed under the terms of the [GNU General Public License](http://www.gnu.org/licenses/). |
||
| 9 | |||
| 10 | Description |
||
| 11 | ----------- |
||
| 12 | Welcome to Blinker for Firefox! |
||
| 13 | |||
| 14 | Blinker enables gaze-based browsing in Mozilla Firefox. |
||
| 15 | |||
| 16 | Requirements |
||
| 17 | ------------ |
||
| 18 | - npm (Node Package Manager): https://nodejs.org |
||
| 19 | - jpm (Node package) |
||
| 20 | - Firefox 38 or up |
||
| 21 | |||
| 22 | |||
| 23 | Setup of the developer environment |
||
| 24 | ---------------------------------- |
||
| 25 | First you need a working installation of npm. If you haven't installed it yet, you can go directly to https://nodejs.org and press INSTALL on their homepage. This should do the job for most installations. |
||
| 26 | |||
| 27 | If npm is up and running, install jpm using the following command: |
||
| 28 | |||
| 29 | $ npm install jpm -g |
||
| 30 | |||
| 31 | Build Blinker XPI |
||
| 32 | ----------------- |
||
| 33 | The Blinker plugin for Firefox can be created with the following |
||
| 34 | command: |
||
| 35 | |||
| 36 | $ jpm xpi |
||
| 37 | |||
| 38 | This command will create a file XXX.xpi, with XXX being an identifier composed of the ID of the plugin, as defined in the package.json file and the version number. This xpi is ready to be handed to users. |
||
| 39 | |||
| 40 | Testing the Plugin |
||
| 41 | ------------------ |
||
| 42 | The plugin can be tested in a dedicated instance of Firefox using the command: |
||
| 43 | |||
| 44 | $ jpm run |