File	Date	Author	Commit
src	2015-02-03	Neil Richardson	[17c230] Replace language-change code with a more generi...
tests	2015-02-03	Neil Richardson	[5a70e1] Add new class 'language' to keep track of our l...
.gitignore	2014-09-27	Neil Richardson	[d60669] Start moving toward using virtualenv and update...
.pylint	2013-07-23	Neil Richardson	[156a23] Tell PyLint not to complain about methods __[in...
1-extract_pot.cmd	2014-04-13	Neil Richardson	[874479] Rename the i18n commands to help indicate the o...
2-update_translations.cmd	2014-04-13	Neil Richardson	[874479] Rename the i18n commands to help indicate the o...
3-convert_to_mo.cmd	2014-04-13	Neil Richardson	[874479] Rename the i18n commands to help indicate the o...
COPYING.TXT	2013-07-05	Neil Richardson	[d1d51c] Initial commit (public version)
KNOWN_PROBLEMS.txt	2015-02-02	Neil Richardson	[745951] More cleanup to KNOWN_PROBLEMS.txt
README.TXT	2015-02-02	Neil Richardson	[ea1d5e] Update to get default language configuration fr...
requirements.txt	2014-09-27	Neil Richardson	[424ba0] Further updates to instructions: wxPython not c...
run_pylint.cmd	2013-07-05	Neil Richardson	[d1d51c] Initial commit (public version)

Read Me

README
=======

Requirements
-------------
These have to be installed manually:
* wx version 2.8.12.1  (Graphical interface)

These will be installed automatically later using pip:
* Mutagen version 1.21  (Metadata library)


Quick Start
------------
Note: At this time (2014) we are not able to run our code inside a virtualenv,
see KNOWN_PROBLEMS.txt for the reason why.

Use pip to install Mutagen:
  pip install -r requirements.txt

(On my system, the installer crashes during clean-up with a scary-looking
traceback about "The directory is not empty", but immediately above that is
a message that ``Successfully installed mutagen.''  The crash occurs during
clean-up, so you can safely ignore it.  You can verify that the package was
installed by performing the following commands:
  python
  import mutagen
  print mutagen.version

If you see ``(1, 21)'' then it installed fine.

You'll have to manually install `wx' because, as noted elsewhere it doesn't
have an automated installer that's compatible with either pip or
virtualenv.  :-(


Usage
------
* Edit the config.ini file and set ``language'' to have the same value as the
  name of one of the folders in './locale'
* python main.py
* Select the left-side tree
* Select the right-side tree
  - The two trees must be non-overlapping or Bad Things(TM) may happen
* Use the checkboxes to determine the comparison criteria to apply
* `Apply' comparison criteria

The middle column should now show a list of the files from the left tree
that matched one or more files in the right tree on the selected criteria.

(Applying a filter with no criteria enabled may yield unpredictable results.)