The official Vimperator source code is hosted on Google Code. In order to work on any of our projects, you will need to get the repository first:
If you don't plan to actively work on the project, you can still browse the repository or monitor changes.
Build a project
You can then build any vimperator labs project by doing:
For example, you can build Vimperator by doing
This will produce an XPI file in the vimperator-labs/downloads folder.
To build all applications, you can use:
Required software to build
- zip
- gmake, awk, sed, sh, echo
While most developers use a Unix-like operating system, you can also build Vimperator on Windows with the help of MinGW's MSYS, Cygwin, or SFU.
Update
Whenever you want to update your local repository to the latest version use:
Creating and installing a new XPI file after each update is cumbersome, therefore there is a simple way to always use the latest Vimperator version after an update. To do so, simply replace the {MY_FIREFOX_PROFILE}/extensions/vimperator@mozdev.org directory with a text file of the same name containing the full path of your vimperator/ directory. This works analogous for the Muttator and Xulmus projects.
Submit patches
We all hope that just cloning/updating the repository is not enough
for you and you start writing your own enhancements or fix some
bugs. When you think the patch is ready send it to the appropriate
mailing list with hg email -o. Make sure that you have
the patchbomb extension enabled and the [email]
section of your hgrc filled out appropriately.
Of course, you can also just do hg diff > my-cool-patch.diff
and use your favorite email program to send patches. Please
attach the patch instead of putting it inline, as many mail programs
break too long lines - creating problems when applying the patch.
Note: For any new or changed feature, documentation and an entry in the NEWS file is required for the patch to be accepted.
Become a developer
Once you have submitted a few well-written patches, usually you are granted commit access which will make the life for all of us easier.
