diff options
| -rw-r--r-- | contexts/README.md | 46 | ||||
| -rw-r--r-- | doc/manual_src/install.md | 9 |
2 files changed, 41 insertions, 14 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. diff --git a/doc/manual_src/install.md b/doc/manual_src/install.md index c7fc328..e459734 100644 --- a/doc/manual_src/install.md +++ b/doc/manual_src/install.md @@ -9,10 +9,11 @@ extension on your local computer. ## Installing FiveUI in Firefox -FiveUI is currently supported on Firefox 10, although it should also -work on newer versions and Firefox 3.6. Due to changes in the -long-term support and Mozilla version numbering scheme, versions 4-9 -are not supported. +FiveUI is currently supported on Firefox 10 (Mozilla's extended +support release version), although it should also work on Firefox +3.6. Due to changes in the long-term support and Mozilla version +numbering scheme, versions 4-9 are not supported. FiveUI is known +not to work in very recent versions of Firefox, e.g. v16. The FiveUI Firefox extension is packaged in a file called `fiveui.xpi`. Locate this file in your distribution (or download) and |