diff options
Diffstat (limited to 'contexts/README.md')
-rw-r--r-- | contexts/README.md | 46 |
1 files changed, 36 insertions, 10 deletions
diff --git a/contexts/README.md b/contexts/README.md index ee0d24b..0f1a6c2 100644 --- a/contexts/README.md +++ b/contexts/README.md @@ -1,14 +1,40 @@ -This is the ffExtension add-on. It contains: +# FiveUI -* A program (lib/main.js). -* A few tests. -* Some meager documentation. +FiveUI is an extensible tool for evaluating HTML user interfaces +against sets of codified UI Guidelines. -Building/running from this directory: +## Installation and getting started + +FiveUI is a basic browser extension with support for Firefox and +Google Chrome. If you're familiar with browser extensions, you can +quickly install FiveUI from the binaries: + + - Chrome: [fiveui.crx](http://galoisinc.github.com/FiveUI/binaries/fiveui.crx) + - FireFox: [fiveui.xpi](http://galoisinc.github.com/FiveUI/binaries/fiveui.xpi) + +The [Installation Guide](doc/manual_src/install.md) describes the +installation process for Firefox and Google Chrome. + +After you've installed FiveUI, take a look at the [Getting Started +Guide](doc/manual_src/gettingStarted.md) to learn about Rule Sets and +setting URL Patterns to match web sites to codified guidelines. + +## Building FiveUI + +Most (if not all) the FiveUI dependencies are included in the +repository, so building FiveUI should be as simple as running: + + $ make + +In the top-level FiveUI repository root. On success, this will put +the generated extensions in the repository root. + +### Chrome signing key + +Note that you will need to first place a Chrome key in: + + chrome\fiveui.pem + +before the chrome extension will build successfully. - - Setup environment: - `pushd <repo root>/tools/addon-sdk-1.3 && source bin/activate && popd` - - Run the extension: - `cfx run -profile ../devProfile` -See `cfx docs` for more details on the add-on build tool. |