Development Information
Development Source
calcurse is released under the BSD license, so feel free to download, modify and redistribute it.
The whole source code currently is under version control using Git as VCS. You can either view recent changes and stats, browse the source tree, and download snapshot tarballs through our cgit web interface or retrieve a local copy of the development tree using:
$ git clone https://git.calcurse.org/calcurse.git/
That creates a new directory calcurse containing the cloned repository. A graphical view of recent development can be requested using the gitk(1) frontend:
$ gitk --all
To update your existing local working copy to the current point of development, run:
$ git pull origin master
If you'd like to follow the maintenance branch (maint) as well, setting up a tracking branch is recommended:
$ git branch -t maint origin/maint
Subsequently, just use git pull which will sync both master and maint branches.
For further documentation and tutorials, check the Git website.
Building calcurse
To build calcurse from development sources, run:
$ ./autogen.sh $ ./configure $ make
Submitting Patches
Patches are always appreciated and can be submitted via GitHub.
Alternatively, patches can be sent to misc at calcurse dot org for discussion or to bugs at calcurse dot org if they are mere bug fixes. Signed-off patches produced by git-format-patch(1) and submitted as an inline attachments via git-send-email(1) are preferred.
The source tree contains a document describing our preferences and general things you should take care of when submitting a patch to calcurse for the first time. A pre-built HTML version of that document can be found here.
In case you are interested in more details and features of Git, check the Git website. Version Control with Git by Jon Loeliger also is a good book to start with.
Getting Started
If you are interested in contributing to calcurse development, the following steps are good to start with:
- Pull in and build the latest development source.
- Check the current list of open feature requests.
- Test and submit your patches to misc at calcurse got org.
Translations
We currently use Transifex to manage calcurse translations. Following languages are available:
To find out more about our translation workflow, check the calcurse i18n section in the manual. Translation contributions are highly appreciated!