arsenetar/dupeguru
1
0
Fork 0
mirror of https://github.com/arsenetar/dupeguru.git synced 2024-11-17 12:39:02 +00:00
Code Releases Wiki Activity
7740dfca0e
dupeguru/README.md

72 lines
2.8 KiB
Markdown
Raw Normal View History

Tweaked README
2013-06-24 20:20:05 +00:00
# dupeGuru
Updated README to include clearer build instructions
2013-06-23 01:43:24 +00:00
Initial Update of Windows Packaging (#438) * Update run.py & .gitignore for windows - Update run.py to execute on windows as SIGQUIT is not available. - Update .gitignore to ignore the generate .pyd files Ref #300, #393 * Update package.py for windows Add package_windows back into package.py - Using cx_freeze for freezing installation - Will be using nsis for actual installer Tested with python 3.5 64bit on windows 10 Ref #393 * Update makefile for windows (+2 misc) - Update the makefile to support windows - Use different bin path in virtualenv - Use pyd instead of so files - Tested with Msys2 - Add *.exe to .gitignore - Fix minor format error in package.py Ref #393 * Add requirements-windows Add the requirements-windows.txt - contains cx-Freeze for bundling Ref #393 * Add initial setup.nsi Initial Version of a NSIS installer script - Multi-user install (install for just one or all) - Registers uninstaller (more values need to finish up) - Tested both single and all install / uninstall and works - Still need to add parameters instead of hardcoded values in some spots - Need to clean up vendor folders / keys if empty on uninstall - Need to add the other dupeGuru languages to the language list - Minor cleanup of script needed as well Ref #393 * Update setup.nsi Updates to setup.nsi including: - Defines from CLI - Version information (MAJOR, MINOR, PATCH) - Bits (64 / 32) - SourcePath (if we wanted something other than build) - Added extra defines to move application specifics to one location - Added extra defines for uninstall information - Added calculation of install size - Added switching between 64 and 32 bit contexts (need to verify functionality) - Updated output file naming - Added NSIS supported languages which are also supported by dupeGuru - Added rest of registry keys for uninstall information - Added missing registry key for installType - Added removeing Vendor folder and registry key if empty on uninstall Should be very close to having this installer script ready to integrate into the package.py script if desired. Ref #393 * Update README & requirements-windows Minor update to README to indicate windows is supported. Add PyQt5 to requirements-windows.txt to make installation easier. * Update packaging for windows - Update package.py to integrate NSIS for windows - Update makefile to deal with a few additional windows issues - Add Windows.md to contain specific windows instructions, if we want this can be merged with README.md - Minor formatting update to setup.nsi Ref #393 * Update README & Windows Instructions - Update the README to include a reference to the Windows instructions. - Add some additional notes into Windows Instructions and remove one incorrect command. - Update .gitignore to ignore all permutations of env* to allow for multiple side by side virtual environments (used to build different versions for windows) Ref: #393 * Update Window.md Fix broken python link and move nsis link for consistency. * More Details in Windows.md Update Windows.md including: - Information on compilier requirements for windows - Notes about the windows 10 sdk - Some clarification around some of the steps - Addition of msys2 links Going to review this a bit more to polish it up. Ref #393.
2017-08-28 23:27:17 +00:00
[dupeGuru][dupeguru] is a cross-platform (Linux, OS X, Windows) GUI tool to find duplicate files in
Update Readme
2020-12-29 20:31:36 +00:00
a system. It is written mostly in Python 3 and has the peculiarity of using
Updated README
2013-12-01 16:26:30 +00:00
[multiple GUI toolkits][cross-toolkit], all using the same core Python code. On OS X, the UI layer
Update Readme
2020-12-29 20:31:36 +00:00
is written in Objective-C and uses Cocoa. On Linux, it is written in Python and uses Qt5.
Updated README
2013-12-01 16:26:30 +00:00
Remove cocoa The cocoa UI code now lives in dupeguru-cocoa.
2017-03-12 01:41:47 +00:00
The Cocoa UI of dupeGuru is hosted in a separate repo: https://github.com/hsoft/dupeguru-cocoa
Update documentation & CI - Remove references to submodules as they are no longer used - Update top level readme with more recent status - Update travis configuration to use python 3.7 instead of latest for now
2019-12-31 23:33:17 +00:00
## Current status
Add Current Status section to README
2015-04-12 19:31:01 +00:00
Update Readme
2020-12-29 20:31:36 +00:00
2020: various bug fixes and small UI improvements have been added. Packaging for MacOS is still a problem.
Add Current Status section to README
2015-04-12 19:31:01 +00:00
Update documentation & CI - Remove references to submodules as they are no longer used - Update top level readme with more recent status - Update travis configuration to use python 3.7 instead of latest for now
2019-12-31 23:33:17 +00:00
Still looking for additional help especially with regards to:
Update Readme
2020-12-29 20:31:36 +00:00
* OSX maintenance: reproducing bugs & cocoa version, building package with Cocoa UI.
* Linux maintenance: reproducing bugs, maintaining PPA repository, Debian package.
* Translations: updating missing strings.
* Documentation: keeping it up-to-date.
Add Windows/Mac maintainer notice in the README
2015-12-25 01:50:33 +00:00
Clean up README
2016-06-06 21:00:57 +00:00
## Contents of this folder
Updated README
2013-12-01 16:26:30 +00:00
Add Current Status section to README
2015-04-12 19:31:01 +00:00
This folder contains the source for dupeGuru. Its documentation is in `help`, but is also
Update documentation & CI - Remove references to submodules as they are no longer used - Update top level readme with more recent status - Update travis configuration to use python 3.7 instead of latest for now
2019-12-31 23:33:17 +00:00
[available online][documentation] in its built form. Here's how this source tree is organized:
Updated README to include clearer build instructions
2013-06-23 01:43:24 +00:00
* core: Contains the core logic code for dupeGuru. It's Python code.
* qt: UI code for the Qt toolkit. It's written in Python and uses PyQt.
* images: Images used by the different UI codebases.
Improved arch packaging No need to bundle a .desktop file with arch source packages anymore. dupeGuru's source package takes care of that.
2014-04-19 21:48:48 +00:00
* pkg: Skeleton files required to create different packages
Updated README to include clearer build instructions
2013-06-23 01:43:24 +00:00
* help: Help document, written for Sphinx.
Update documentation & CI - Remove references to submodules as they are no longer used - Update top level readme with more recent status - Update travis configuration to use python 3.7 instead of latest for now
2019-12-31 23:33:17 +00:00
* locale: .po files for localization.
Updated README to include clearer build instructions
2013-06-23 01:43:24 +00:00
* hscommon: A collection of helpers used across HS applications.
* qtlib: A collection of helpers used across Qt UI codebases of HS applications.
Clean up README
2016-06-06 21:00:57 +00:00
## How to build dupeGuru from source
Updated README to include clearer build instructions
2013-06-23 01:43:24 +00:00
Initial Update of Windows Packaging (#438) * Update run.py & .gitignore for windows - Update run.py to execute on windows as SIGQUIT is not available. - Update .gitignore to ignore the generate .pyd files Ref #300, #393 * Update package.py for windows Add package_windows back into package.py - Using cx_freeze for freezing installation - Will be using nsis for actual installer Tested with python 3.5 64bit on windows 10 Ref #393 * Update makefile for windows (+2 misc) - Update the makefile to support windows - Use different bin path in virtualenv - Use pyd instead of so files - Tested with Msys2 - Add *.exe to .gitignore - Fix minor format error in package.py Ref #393 * Add requirements-windows Add the requirements-windows.txt - contains cx-Freeze for bundling Ref #393 * Add initial setup.nsi Initial Version of a NSIS installer script - Multi-user install (install for just one or all) - Registers uninstaller (more values need to finish up) - Tested both single and all install / uninstall and works - Still need to add parameters instead of hardcoded values in some spots - Need to clean up vendor folders / keys if empty on uninstall - Need to add the other dupeGuru languages to the language list - Minor cleanup of script needed as well Ref #393 * Update setup.nsi Updates to setup.nsi including: - Defines from CLI - Version information (MAJOR, MINOR, PATCH) - Bits (64 / 32) - SourcePath (if we wanted something other than build) - Added extra defines to move application specifics to one location - Added extra defines for uninstall information - Added calculation of install size - Added switching between 64 and 32 bit contexts (need to verify functionality) - Updated output file naming - Added NSIS supported languages which are also supported by dupeGuru - Added rest of registry keys for uninstall information - Added missing registry key for installType - Added removeing Vendor folder and registry key if empty on uninstall Should be very close to having this installer script ready to integrate into the package.py script if desired. Ref #393 * Update README & requirements-windows Minor update to README to indicate windows is supported. Add PyQt5 to requirements-windows.txt to make installation easier. * Update packaging for windows - Update package.py to integrate NSIS for windows - Update makefile to deal with a few additional windows issues - Add Windows.md to contain specific windows instructions, if we want this can be merged with README.md - Minor formatting update to setup.nsi Ref #393 * Update README & Windows Instructions - Update the README to include a reference to the Windows instructions. - Add some additional notes into Windows Instructions and remove one incorrect command. - Update .gitignore to ignore all permutations of env* to allow for multiple side by side virtual environments (used to build different versions for windows) Ref: #393 * Update Window.md Fix broken python link and move nsis link for consistency. * More Details in Windows.md Update Windows.md including: - Information on compilier requirements for windows - Notes about the windows 10 sdk - Some clarification around some of the steps - Addition of msys2 links Going to review this a bit more to polish it up. Ref #393.
2017-08-28 23:27:17 +00:00
### Windows
For windows instructions see the [Windows Instructions](Windows.md).
Remove cocoa The cocoa UI code now lives in dupeguru-cocoa.
2017-03-12 01:41:47 +00:00
### Prerequisites
Update documentation & CI - Remove references to submodules as they are no longer used - Update top level readme with more recent status - Update travis configuration to use python 3.7 instead of latest for now
2019-12-31 23:33:17 +00:00
* [Python 3.5+][python]
Remove cocoa The cocoa UI code now lives in dupeguru-cocoa.
2017-03-12 01:41:47 +00:00
* PyQt5
Add Makefile I finally took the time to properly learn how to write makefiles. This was long overdue, but here we go. Much of the makefile wraps `build.py`, but gradually, we'll extract stuff from there until the makefile is the main container for build logic.
2016-08-16 02:38:47 +00:00
### make
Remove cocoa The cocoa UI code now lives in dupeguru-cocoa.
2017-03-12 01:41:47 +00:00
dupeGuru is built with "make":
Add Makefile I finally took the time to properly learn how to write makefiles. This was long overdue, but here we go. Much of the makefile wraps `build.py`, but gradually, we'll extract stuff from there until the makefile is the main container for build logic.
2016-08-16 02:38:47 +00:00
Move up to 4.0.5 * Initial push to 4.0.5 milestone * Update changelog
2020-10-27 18:37:26 +00:00
$ make && make run
Add Makefile I finally took the time to properly learn how to write makefiles. This was long overdue, but here we go. Much of the makefile wraps `build.py`, but gradually, we'll extract stuff from there until the makefile is the main container for build logic.
2016-08-16 02:38:47 +00:00
Update packaging for 4.0.4 * Fix main version (Don't use spaces and capitals in versions!) * Change debian changelog format in hscommon * Fix build cleanup * Switch to XZ compression * Update build instructions * Build single package for both Debian/Ubuntu * Update packaging
2019-08-29 19:01:04 +00:00
### Generate Debian/Ubuntu package
Update packaging to conform with package unification and few fixes (#372) * Rename package (dupeguru-se -> dupeguru) * Update package name in .desktop files and scripts * Add Ubuntu package building instructions * Fix build_pe_modules.py * Add description to package * Add conflicts dependencies to replace previous versions * Update python version * Unify .json configs * Few cosmetics changes (mainly missing end-lines and images permissions)
2016-06-29 02:39:23 +00:00
Update packaging for 4.0.4 * Fix main version (Don't use spaces and capitals in versions!) * Change debian changelog format in hscommon * Fix build cleanup * Switch to XZ compression * Update build instructions * Build single package for both Debian/Ubuntu * Update packaging
2019-08-29 19:01:04 +00:00
$ bash -c "python3 -m venv --system-site-packages env && source env/bin/activate && pip install -r requirements.txt && python3 build.py --clean && python3 package.py"
Update packaging to conform with package unification and few fixes (#372) * Rename package (dupeguru-se -> dupeguru) * Update package name in .desktop files and scripts * Add Ubuntu package building instructions * Fix build_pe_modules.py * Add description to package * Add conflicts dependencies to replace previous versions * Update python version * Unify .json configs * Few cosmetics changes (mainly missing end-lines and images permissions)
2016-06-29 02:39:23 +00:00
Clean up README
2016-06-06 21:00:57 +00:00
### Running tests
Add tox instructions in README Also, remove py33 from tox envlist
2016-01-05 22:14:05 +00:00
Fix verb tense in README.md (#406)
2017-01-09 03:34:49 +00:00
The complete test suite is run with [Tox 1.7+][tox]. If you have it installed system-wide, you
Add tox instructions in README Also, remove py33 from tox envlist
2016-01-05 22:14:05 +00:00
don't even need to set up a virtualenv. Just `cd` into the root project folder and run `tox`.
If you don't have Tox system-wide, install it in your virtualenv with `pip install tox` and then
run `tox`.
You can also run automated tests without Tox. Extra requirements for running tests are in
`requirements-extra.txt`. So, you can do `pip install -r requirements-extra.txt` inside your
virtualenv and then `py.test core hscommon`
Update README.md and ISSUE_TEMPLATE.md - Update ISSUE_TEMPLATE.md to help obtain better information for bug reports. - Update README.md to reflect more recent changes and highlight areas of need.
2018-10-11 02:12:01 +00:00
[dupeguru]: https://dupeguru.voltaicideas.net/
Updated README
2013-12-01 16:26:30 +00:00
[cross-toolkit]: http://www.hardcoded.net/articles/cross-toolkit-software
Update README.md and ISSUE_TEMPLATE.md - Update ISSUE_TEMPLATE.md to help obtain better information for bug reports. - Update README.md to reflect more recent changes and highlight areas of need.
2018-10-11 02:12:01 +00:00
[documentation]: http://dupeguru.voltaicideas.net/help/en/
Tweaked README
2013-06-24 20:20:05 +00:00
[python]: http://www.python.org/
[pyqt]: http://www.riverbankcomputing.com
Current status: unmaintained
2018-02-15 03:42:40 +00:00
[tox]: https://tox.readthedocs.org/en/latest/
Copy Permalink