Go to file

Romain Failliot c46506f1d6 Fix encoding detection.		2016-08-26 08:20:29 -04:00
src	Fix encoding detection.	2016-08-26 08:20:29 -04:00
translations	First commit	2015-11-21 12:57:32 -05:00
utils	First commit	2015-11-21 12:57:32 -05:00
windows-installer	Fix installer.	2016-08-18 13:28:01 -04:00
AUTHORS	First commit	2015-11-21 12:57:32 -05:00
COPYING	First commit	2015-11-21 12:57:32 -05:00
ChangeLog	Bump to version 0.5.0 (still in alpha)	2016-07-21 04:00:22 -04:00
README.md	Bump to version 0.5.0 (still in alpha)	2016-07-21 04:00:22 -04:00
install.py	First commit	2015-11-21 12:57:32 -05:00

README.md

Diffuse

Version 0.5.0

Diffuse is a graphical tool for merging and comparing text files. Diffuse is able to compare an arbitrary number of files side-by-side and gives users the ability to manually adjust line matching and directly edit files. Diffuse can also retrieve revisions of files from Bazaar, CVS, Darcs, Git, Mercurial, Monotone, RCS, Subversion, and SVK repositories for comparison and merging.

Some key features of Diffuse:

Ability to compare and merge an arbitrary number of files side-by-side (n-way merges)
Line matching can be manually corrected by the user
Ability to directly edit files
Syntax highlighting
Bazaar, CVS, Darcs, Git, Mercurial, Monotone, RCS, Subversion, and SVK support
Unicode support
Unlimited undo
Easy keyboard navigation

Requirements

Python >= 3.4
PyGObject >= 3.18

Diffuse is implemented entirely in Python and should run on any platform with Python and PyGTK. If you need to manually install PyGTK, please be aware its dependencies should be installed prior to installing PyGTK.

Diffuse can be run directly from an untared source distribution on any POSIX system or installed with the instructions described in the next section.

The location of the personal preferences, state, and initialisation files have changed in the 0.4.1 release. Old settings may be migrated using the following commands:

$ mkdir -p ~/.config/diffuse
$ mv ~/.diffuse/config ~/.config/diffuse/state
$ mv ~/.diffuse/* ~/.config/diffuse
$ rmdir ~/.diffuse

The rules for parsing files in ~/.diffuse changed in the 0.3.0 release. Non-fatal errors may be reported when parsing old files. These errors can be fixed by removing the offending lines (or the entire file) from ~/.config/diffuse/diffuserc.

Installing on POSIX systems

Run the install.py script to install Diffuse. The script accepts several options for customising the installation behaviour. Use the --help option to obtain a full listing.

Diffuse can be removed by running the install.py script with the --remove option.

Specify the --destdir= and --files-only options for the install.py script when using it to build a platform specific package of Diffuse.

Installing on Windows

The windows-installer directory contains scripts for building an installable package for Windows that includes all dependencies.

Diffuse can be packaged as a portable application by copying the installation directory to a pen drive and creating a front end that sets the XDG_CONFIG_HOME and XDG_DATA_DIR environment variables prior to launching Diffuse. The XDG_CONFIG_HOME and XDG_DATA_DIR environment variables indicate where Diffuse should store persistent settings (eg. the path to a writable directory on the pen drive).

Help Documentation

Diffuse's help documentation is written in the DocBook format and can be easily converted into other formats using XSLT stylesheets. If the local help documentation or its browser are unavailable, Diffuse will attempt to display the on-line help documentation using a web browser.