File:  [mozdev] / anykey / www / development.html
Revision 1.1: download - view: text, annotated - select for diffs - revision graph
Fri Apr 28 18:19:18 2006 UTC (11 years, 5 months ago) by taye
Branches: MAIN
CVS tags: HEAD
*** empty log message ***

<html><head><!-- MAIN CONTENT --></head><body><div style="max-width: 575px ! important;">
<h2>Development Setup</h2>

<p>
Use the following procedure to setup a uniform development environment:

</p><ol>
<li>I use java/ant for builds, so install <a href="http://java.sun.com/j2se/1.4.2/download.html">jre or jdk</a>.</li>
<li>Install <a href="http://ant.apache.org/">ant</a>, set ANT_HOME environment variable and add ant/bin to the Path environment variable, so you can run ant from command line.</li>
<li>Visit the <a href="http://kb.mozillazine.org/Dev_:_Extensions#Setting_up_your_environment">mozillazine knowledge base</a> and set the FireFox environment to allow debugging messages in the console, etc.</li>
<li>Follow <a href="http://kb.mozillazine.org/Viewing_dump%28%29_output">this procedure</a> to make sure you can open FireFox with a console running, so you will be able to see the 'dump' messages.</li>
<li>Setup a <a href="http://www.wincvs.org/">cvs client</a>, check <a href="file:///C:/Documents%20and%20Settings/Administrateur/Bureau/source.html">this page</a> for cvs settings.</li>
<li>Download the latest source from the source tree.</li>
<li>Find the 'build.properties' file under the 'anykey' folder, you will need to modify one property: 'extension_dir'.
Set it to wherever the extension's 'chrome' directory is stored on your system (use forward slashes as path seperators only.)
For example on a windows machine this line could look like this:
<textarea rows="3" cols="70">extension_dir=H:/Documents and
Settings/roman/Application
Data/Mozilla/Firefox/Profiles/default.0dn/extensions/{60dc76ae-47f1-42e5-997f-7f1ef3d6f3e8}/chrome
</textarea>
</li>
<li>In the 'anykey' folder create a new executable script file such as
'make.bat' or 'make.sh' for example that contains the following line: <i>ant update</i>.
When you run 'update' target from the build.xml, the anykey.jar file in
the extension chrome directory will be updated with the new one from
your current source. This means that in order to test your source, you
can just close the browser, run the make script to update the
anykey.jar file and then open the browser.</li>
</ol>
<br>
Now you can be sure you are working within a uniform environment with the other developers on this project.
For editing you can use <a href="http://www.eclipse.org/">java/Eclipse</a> plugin environment with <a href="http://jseditor.sourceforge.net/">this Javascript plugin</a>.
<br><br>
Obviously you can skip this process and create your own build scripts, here is a <a href="http://www.7-zip.org/">zip tool</a> that can be used from command line.
<p></p>

<p>
Useful reference links:
</p><ul>
<li><a href="http://bookmarklet.blogspot.com/2004_11_01_bookmarklet_archive.html">Javascript and XUL</a></li>
</ul>
<p></p>

</div>
</body></html>

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>