1
0
mirror of https://github.com/arsenetar/dupeguru.git synced 2024-10-31 22:05:58 +00:00
Go to file
2011-04-15 14:42:14 +02:00
cocoa [#89 state:fixed] Added a Folders scan type in dgse. 2011-04-12 13:22:29 +02:00
core Fixed exclusion bug during folders scan. 2011-04-14 15:37:12 +02:00
core_me Updated copyright year to 2011. 2011-04-12 10:04:01 +02:00
core_pe [#89 state:fixed] Added a Folders scan type in dgse. 2011-04-12 13:22:29 +02:00
core_se Fixed exclusion bug during folders scan. 2011-04-14 15:37:12 +02:00
debian_me Updated copyright year to 2011. 2011-04-12 10:04:01 +02:00
debian_pe Updated copyright year to 2011. 2011-04-12 10:04:01 +02:00
debian_se Updated copyright year to 2011. 2011-04-12 10:04:01 +02:00
help [#89 state:fixed] Added a Folders scan type in dgse. 2011-04-12 13:22:29 +02:00
images Replaced 'Add' and 'Remove' by + and - icons in the directories dialog under Qt. 2011-01-18 11:07:56 +01:00
qt [#89 state:fixed] Added a Folders scan type in dgse. 2011-04-12 13:22:29 +02:00
.hgignore Changed sphinxgen's mechanism so that we don't have to copy the whole sphinx source dir every time we generate help. 2011-01-22 17:06:04 +01:00
.hgtags Added tag se3.0.2 for changeset 77e169f75719 2011-03-16 15:30:07 +01:00
build.py Updated copyright year to 2011. 2011-04-12 10:04:01 +02:00
configure.py Updated copyright year to 2011. 2011-04-12 10:04:01 +02:00
LICENSE Updated copyright year to 2011. 2011-04-12 10:04:01 +02:00
package.py Merged heads 2011-04-12 13:29:27 +02:00
README pe v2.1.0 2011-03-07 11:33:40 +01:00
run_template_cocoa.py Replaced the use of runpy for running Qt by a simple subprocess call. runpy would cause weird QTimer warnings. 2010-10-05 09:27:32 +02:00
run_template_qt.py Updated copyright year to 2011. 2011-04-12 10:04:01 +02:00

Contents
========

This package contains the source for dupeGuru. To learn how to build it, refer to the "Build dupeGuru" section. Below is the description of the various subfolders:

- core: Contains the core logic code for dupeGuru. It's Python code written in TDD style.
- core_*: Edition-specific-cross-toolkit code written in Python.
- cocoa: UI code for the Cocoa toolkit. It's Objective-C code.
- qt: UI code for the Qt toolkit. It's written in Python and uses PyQt.
- images: Images used by the different UI codebases.
- debian_*: Skeleton files required to create a .deb package
- help: Help document, written for Sphinx.

There are also other sub-folder that comes from external repositories (automatically checked out
with as mercurial subrepos):

- hscommon: A collection of helpers used across HS applications.
- cocoalib: A collection of helpers used across Cocoa UI codebases of HS applications.
- qtlib: A collection of helpers used across Qt UI codebases of HS applications.

dupeGuru Dependencies
=====================

Before being able to build dupeGuru, a few dependencies have to be installed:

General dependencies
--------------------

- Python 3.1 (3.2 on Mac OS X) (http://www.python.org)
- Send2Trash3k (http://hg.hardcoded.net/send2trash)
- hsaudiotag3k 1.1.0 (for ME) (http://hg.hardcoded.net/hsaudiotag)
- jobprogress (http://hg.hardcoded.net/jobprogress)
- Sphinx 1.0.6 (http://sphinx.pocoo.org/)
- pytest 2.0.0, to run unit tests. (http://pytest.org/)

Note: Sphinx doesn't officially support Python 3.x yet, but it doesn't matter because it is invoked
by the build system through command line, so you can build dupeGuru even if Sphinx is installed in
your Python 2.x install.

OS X prerequisites
------------------

- XCode 3.1 (http://developer.apple.com/TOOLS/xcode/)
- Sparkle (http://sparkle.andymatuschak.org/)
- PyObjC 2.3 (http://pyobjc.sourceforge.net/)
- pluginbuilder 1.0.1 (http://bitbucket.org/hsoft/pluginbuilder)
- appscript 1.0.0 for ME and PE (http://appscript.sourceforge.net/)

Windows prerequisites
---------------------

- Visual Studio 2008 (Express is enough) is needed to build C extensions. (http://www.microsoft.com/Express/)
- PyQt 4.7.5 (http://www.riverbankcomputing.co.uk/news)
- cx_Freeze, if you want to build a exe. You don't need it if you just want to run dupeGuru. (http://cx-freeze.sourceforge.net/)
- Advanced Installer, if you want to build the installer file. (http://www.advancedinstaller.com/)

Building dupeGuru
=================

First, make sure you meet the dependencies listed in the section above. Then you need to configure your build with:

	python configure.py
	
If you want, you can specify a UI to use with the `--ui` option. So, if you want to build dupeGuru with Qt on OS X, then you have to type `python configure.py --ui=qt`. You can also use the `--dev` flag to indicate a dev build (it will build `dg_cocoa.plugin` in alias mode and use the "dev" config in XCode).

Then, just build the thing and then run it with:

	python build.py
	python run.py

If you want to create ready-to-upload package, run:

	python package.py