From aabb32d7d2b3a34ad3747584ebe2766117eeedd0 Mon Sep 17 00:00:00 2001 From: Trevor Elliott Date: Tue, 18 Jun 2013 10:13:48 -0700 Subject: Documentation updates * Say something about packaging with the package target * Document the run-firefox target --- README.md | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) (limited to 'README.md') 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: -- cgit v1.2.3