aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorGravatar Trevor Elliott <trevor@galois.com>2013-06-18 10:13:48 -0700
committerGravatar Trevor Elliott <trevor@galois.com>2013-06-18 10:13:48 -0700
commitaabb32d7d2b3a34ad3747584ebe2766117eeedd0 (patch)
treefacd2ad58a58d8265df327ce637140231ed9ea50 /README.md
parent5d8b2f52cf694e30cc90f885c41ab353cbf87323 (diff)
Documentation updates
* Say something about packaging with the package target * Document the run-firefox target
Diffstat (limited to 'README.md')
-rw-r--r--README.md16
1 files changed, 14 insertions, 2 deletions
diff --git a/README.md b/README.md
index 9b39f16..2404239 100644
--- a/README.md
+++ b/README.md
@@ -26,8 +26,11 @@ 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 top-level directory.
+The default target will stage both extensions into the `build/chrome` and
+`build/firefox` directories, respectively. To build the packaged extensions,
+use the `package` target.
+
+ $ make package
### Chrome signing key
@@ -43,6 +46,15 @@ See the
on how to load an unpacked extension using "Developer mode". You should use the
`build/chrome/` directory for this.
+### Running the Firefox Extension Unpacked
+
+The build system provides a `run-firefox` target that will make sure that the
+staged extension is up to date, and then execute the `cfx run` command in the
+right context.
+
+ $ make run-firefox
+
+
## Running the tests
The `make test` target depends on: