README.markdown 2.3 KB

Zombie Navigator

A simple Firefox automation addon

  • src/ The addon source code
  • branding/ Branding source code (artworks)
  • jsdoc/ JSDoc-based API documentation source code (experimental)
  • build-docs.sh Build the API documentation with JSDoc
  • build.sh Build the addon
  • run.sh Run the addon off the source tree (requires non-release non-beta Firefox due to signing requirement)
  • LICENSE The GNU Affero General Public License, version 3

Firefox (or equivalent) 38+ is required.

Build requirements

  • Built using jpm: install with npm install -g jpm
  • API documentation built with JSDoc: npm install -g jsdoc (to regenerate documentations)
  • (Optional) AdvanceCOMP (advzip utility)
  • Build scripts only support Unix-like systems

TODO

  • Make sure the API is always reliable
  • Enable to quit the browser if there has been no user interaction

Branding

We named this program "Zombie Navigator" because it effectively turns Firefox into an automated "zombie" web browser. "Zombie scripts", which run inside a secure sandbox navigate Firefox!

The icon says "Web Browser" in Arabic. Just that. Maybe too simple. But we do not invest much in visual design.

Firefox is a registered trademark of the Mozilla Foundation. The term "Firefox" in this product, however, may also mean rebranded products derived from the official Firefox.

Versioning

License

Copyright © 2015 Zombie Navigator Developers

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with this program. If not, see http://www.gnu.org/licenses/.

The GNU Affero General Public License (GNU AGPL for short) is included under the file name 'LICENSE'