User:Mconnor/Past/WeaveSourceReorg/BuildDocs: Difference between revisions

Jump to navigation Jump to search
describe building for install vs for development →‎Building the Extension
No edit summary
(describe building for install vs for development →‎Building the Extension)
Line 36: Line 36:
  make crypto rebuild_crypto=1
  make crypto rebuild_crypto=1


=== Building the Extension ===
=== Building the Extension For Install ===


To build a working stage directory (useful for active extension development) and a ready-to-use XPI, please type the following into your shell:
To build a Weave .xpi to install, just type the following in to your shell:


  make xpi
  make xpi


Yes, that's it.
This will generate a <tt>.xpi</tt> file located at <tt>weave/dist/xpi/weave-{version}.xpi</tt>. You can then open that file from Firefox to install the extension.
 
=== Building the Extension For Development ===
 
You could use the above <tt>make xpi</tt> for development and install then restart every time you make a change, but you can be more efficient with another command. It requires a little more up-front setup, but it saves a lot of time down the line.
 
Note, this only works for systems that support "symlinks", so this won't work on Windows.
 
First create an [https://developer.mozilla.org/en/Setting_up_extension_development_environment#Firefox_extension_proxy_file extension proxy]:
# Find your [http://kb.mozillazine.org/Profile_folder profile directory]
# Create a plain text file at <profile>/extensions/{340c2bbc-ce74-4362-90b5-7c26312808ef}
# Edit that file with a single line referencing <path to weave>/dist/stage
 
Assuming you know where your weave files are and your profile directory, you can do this in a single line on OS X:
 
echo /Path/To/weave/dist/stage > ~/Library/Application\ Support/Firefox/Profiles/xr4nd0mx.profile/extensions/{340c2bbc-ce74-4362-90b5-7c26312808ef}
 
Now you just need to build Weave from the weave directory:
 
make
 
That's all!
 
Any future changes to files under <tt>weave/source/</tt> will work after you restart Firefox. You don't even need to run <tt>make</tt> again. The only time you would need to re-run <tt>make</tt> is if you change a <tt>.in</tt> file or the values used in the <tt>.in</tt> file.


=== Setting up to run tests ===
=== Setting up to run tests ===
385

edits

Navigation menu