diff --git a/README.md b/README.md index cdc42b4..e4d905c 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,5 @@ # Diffuse + Version 0.4.8 Copyright (C) 2006-2014 Derrick Moser @@ -13,23 +14,21 @@ 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 ----- +* 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: +## Requirements -- Python >= 2.4 -- PyGTK >= 2.10 - ----- +* Python >= 2.4 +* PyGTK >= 2.10 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 @@ -42,47 +41,41 @@ 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 + $ 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. +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. +`~/.config/diffuse/diffuserc`. ----- +## Installing on POSIX systems -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 +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' +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' +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 -Installing on Windows: - -The 'windows-installer' directory contains scripts for building an installable +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). +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: +## 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