Next: , Previous: Installing from a Source Archive, Up: Getting the Files


3.1.2 Installing from git

The git version control system allows you to keep up-to-date with the latest changes to the development version of Planner. It also allows you to contribute changes (via commits, if you are have developer access to the repository, or via patches, otherwise). If you would like to contribute to Muse development, it is highly recommended that you use git.

Debian users can install git with apt-get install git-core.

If you are new to git, you might find this tutorial helpful: http://www.kernel.org/pub/software/scm/git/docs/tutorial.html.

Downloading Planner with git and staying up-to-date involves the following steps.

     # Retrieve Muse
     git clone git://repo.or.cz/muse-el.git muse
     
     # Retrieve Planner
     git clone git://repo.or.cz/planner-el.git planner
     
     # Retrieve Remember
     git clone git://repo.or.cz/remember-el.git remember
     
     # If that didn't work (due to a restrictive firewall), then try the
     # following instead:
     #
     # git clone http://repo.or.cz/r/muse-el.git muse
     # git clone http://repo.or.cz/r/planner-el.git planner
     # git clone http://repo.or.cz/r/remember-el.git remember

Then add the following lines to your ~/.emacs:

     ;; Add the directories to your load path
     (add-to-list 'load-path "/path/to/muse/lisp")
     (add-to-list 'load-path "/path/to/planner")
     (add-to-list 'load-path "/path/to/remember")
     
     ;; Load planner
     (require 'planner)

You can also browse Planner's git repository on the web at http://repo.or.cz/w/planner-el.git.

Updating Your Version

To stay up-to-date using git, here are some commands that might be useful.

To list upstream changes not in local copy:

Do this whenever you want to see whether new changes have been committed to Planer. If you wish, you may skip this step and proceed directly to the “update” step.

     # Change to the source directory you are interested in. Example:
     cd muse/
     
     # Fetch new changes from the repository, but don't apply them yet
     git fetch origin
     
     # Display log messages for the new changes
     git log HEAD..origin

“origin” is git's name for the location where you originally got Muse from. You can change this location at any time by editing the .git/config file in the directory where the Planner source was placed.

To update to the latest version:

     cd muse; git pull
     cd ../planner; git pull
     cd ../remember; git pull

Don't forget to either rerun the make command or delete the byte-compiled files (*.elc) in the directories, so that the new code will be used.