Developers
Tomboy is open source software licensed by the LGPL. We welcome anyone to peruse the code, offer suggestions, submit corrections, etc. However, submitting your ideas/code/patches will not guarantee that we'll include them automatically. Following the guidelines given on this page will help your case.
Windows or Mac Developers
The following notes are geared for Linux. See Windows Build Notes for Windows-specific instructions and Mac Build Notes for Mac-specific instructions.
Getting the Source Code
Tomboy's source code is stored in Git. To get a working copy of the latest available source code, type:
git clone git://git.gnome.org/tomboy
If you have a GNOME git acccount, use the following:
git clone ssh://[login]@git.gnome.org/git/tomboy
Browse the code online using http://git.gnome.org/cgit/tomboy .
Compiling
You'll need a bunch of *-devel packages installed (gtk2-devel, gnome-common, intltool, etc.).
sudo apt-get build-dep tomboy #if you're using Ubuntu sudo zypper si -d tomboy #if you're using openSUSE
Then, you'll run the following in the tomboy/ directory:
mkdir -p /home/[username]/stage/tomboy ./autogen.sh --prefix=/home/[username]/stage/tomboy --disable-scrollkeeper make make install /home/[username]/stage/tomboy/bin/tomboy
(Replace [username] with your user name)
Installing to a prefix in your home directory (instead of /usr) is nice because then you don't have to overwrite your system Tomboy, and you don't have to use your root password when you run make install.
Alternatively, you can omit the make install step and run Tomboy directly in the tomboy/ directory (currently broken if you use add-ins):
make run
Current Bug List
Submitting Patches
Before submitting patches, please read the following:
Tomboy/HowToSubmitPatches (needs to be updated for Git, see below)
New Authors
We welcome new Tomboy authors with open arms. There are some things to keep in mind though:
- Committing to git
Run `git pull --rebase` before you push to get any changes that could have happened in the meantime. Fix and adjust your code as necessary.
Follow Git/CommitMessages when writing your commit message.
Use `git format-patch HEAD~1` to create a patch from your commit (see Git/Developers)
- When in doubt, ask one of the other Authors/Maintainers for help
Requesting a GNOME git Account
Visit the NewAccounts page and follow the instructions.
TODO
This page needs a LOT more information. Please help by adding more content.
