1
0
mirror of https://github.com/arsenetar/dupeguru.git synced 2024-10-31 22:05:58 +00:00
Go to file
Virgil Dupras 492c577184 se v2.9.1
2010-01-13 16:06:59 +01:00
cocoa se v2.9.1 2010-01-13 16:06:59 +01:00
core Removed redudant license files. 2010-01-13 10:07:14 +01:00
core_me Fixed core_me.tests.scanner_test which was broken. 2010-01-13 09:35:37 +01:00
core_pe Removed redudant license files. 2010-01-13 10:07:14 +01:00
core_se Removed redudant license files. 2010-01-13 10:07:14 +01:00
help_me Improved the cocoa build process. 2010-01-01 21:42:52 +01:00
help_pe Improved the cocoa build process. 2010-01-01 21:42:52 +01:00
help_se se v2.9.1 2010-01-13 16:06:59 +01:00
images dgse cocoa: extracted the pref pane from MainMenu.xib into Preferences.xib, Removed column menu items, which are now generated in the code. other little things. 2009-10-30 12:56:05 +00:00
qt se v2.9.1 2010-01-13 16:06:59 +01:00
.hgignore Removed APPNAME and LIMIT_DESC consts from cocoa. 2010-01-13 09:30:10 +01:00
.hgtags Added tag pe1.8.0 for changeset cbcf9c80fee4 2009-12-31 14:14:10 +01:00
build.py Removed svn keywords. 2010-01-02 16:52:18 +01:00
configure.py Removed svn keywords. 2010-01-02 16:52:18 +01:00
LICENSE Changed copyright year to 2010 2010-01-01 21:11:34 +01:00
package.py Removed svn keywords. 2010-01-02 16:52:18 +01:00
README Changed the build system (that commit is *huge*) 2009-12-30 16:34:41 +00:00
run.py Removed svn keywords. 2010-01-02 16:52:18 +01:00

Contents
=====

This package contains the source for dupeGuru. To learns 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. Before redistributing changes in this part of the code, read the "qt/WARNING" file.
- images: Images used by the different UI codebases.

There are also other sub-folder that comes from external repositories (automatically checked out
with svn:externals):

- hsutil: A collection of helpers used across HS applications.
- hsdocgen: An ad-hoc document generation used across HS project (used for help files)
- hsmedia: A library to read audio file metadata, used in dupeGuru ME.
- 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 2.6 (http://www.python.org)
- Mako, to generate help files. (http://www.makotemplates.org/)
- PyYaml, for help files and the build system. (http://pyyaml.org/)
- Nose, to run unit tests. (http://somethingaboutorange.com/mrl/projects/nose/)
- Cython to compile a few optimized bottlenecks. (http://www.cython.org/)
- Python Imaging Library for dupeGuru PE. (http://www.pythonware.com/products/pil/)

OS X prerequisites
-----

- XCode 3.1 (http://developer.apple.com/TOOLS/xcode/)
- Sparkle (http://sparkle.andymatuschak.org/)
- PyObjC. Although Tiger support has been dropped with dupeGuru 1.7, I still use PyObjC 1.4 because funky stuff happens with newer releases. However, it's mostly related to packaging with py2app. (http://pyobjc.sourceforge.net/)
- py2app (http://svn.pythonmac.org/py2app/py2app/trunk/doc/index.html)

Windows prerequisites
---

- Visual Studio 2008 (Express is enough) is needed to build the Cython extensions. (http://www.microsoft.com/Express/)
- PyQt 4.6 (http://www.riverbankcomputing.co.uk/news)
- PyInstaller, if you want to build a exe. You don't need it if you just want to run dupeGuru. (http://www.pyinstaller.org/)
- 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 `mg_cocoa.plugin` in alias mode).

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