Clean up README
This commit is contained in:
Virgil Dupras
parent
76f3332d36
commit
c4aeda0bd0
30
README.md
30
README.md
|
|
@ -1,11 +1,11 @@
|
|||
# dupeGuru
|
||||
|
||||
[dupeGuru][dupeguru] is a cross-platform (Linux, OS X, Windows) GUI tool to find duplicate files in
|
||||
[dupeGuru][dupeguru] is a cross-platform (Linux and OS X) GUI tool to find duplicate files in
|
||||
a system. It's written mostly in Python 3 and has the peculiarity of using
|
||||
[multiple GUI toolkits][cross-toolkit], all using the same core Python code. On OS X, the UI layer
|
||||
is written in Objective-C and uses Cocoa. On Linux, it's written in Python and uses Qt5.
|
||||
|
||||
# Current status: People wanted
|
||||
## Current status: People wanted
|
||||
|
||||
dupeGuru has currently only one maintainer, me. This is a dangerous situation that needs to be
|
||||
corrected.
|
||||
|
|
@ -17,7 +17,7 @@ Whatever your skills, if you are remotely interestested in being a contributor,
|
|||
mentoring you. If that's the case, please refer to [the open ticket on the subject][contrib-issue]
|
||||
and let's get started.
|
||||
|
||||
## Slowed development
|
||||
### Slowed development
|
||||
|
||||
Until I manage to find contributors, I'm slowing the development pace of dupeGuru. I'm not much
|
||||
interested in maintaining it alone, I personally have no use for this app (it's been a *loooong*,
|
||||
|
|
@ -29,13 +29,13 @@ triaging, code review, critical bugfixes, releases management.
|
|||
But anything non-critical, I'm not going to implement it myself because I see every issue as a
|
||||
contribution opportunity.
|
||||
|
||||
## Windows maintainer wanted
|
||||
### Windows maintainer wanted
|
||||
|
||||
As [described on my website][nowindows], v3.9.x/6.8.x/2.10.x series of dupeGuru are the last ones
|
||||
to support Windows unless someone steps up to maintain it. If you're a Windows developer and are
|
||||
interested in taking this task, [don't hesitate to let me know][contrib-issue].
|
||||
|
||||
## OS X maintainer wanted
|
||||
### OS X maintainer wanted
|
||||
|
||||
My Mac Mini is already a couple of years old and is likely to be my last Apple purchase. When it
|
||||
dies, I will be unable maintain the OS X version of moneyGuru. I've already stopped paying for the
|
||||
|
|
@ -43,13 +43,12 @@ Mac Developer membership so I can't sign the apps anymore (in the "official way"
|
|||
download is still PGP signed) If you're a Mac developer and are interested in taking this task,
|
||||
[don't hesitate to let me know][contrib-issue].
|
||||
|
||||
# Contents of this folder
|
||||
## Contents of this folder
|
||||
|
||||
This folder contains the source for dupeGuru. Its documentation is in `help`, but is also
|
||||
[available online][documentation] in its built form. Here's how this source tree is organised:
|
||||
|
||||
* core: Contains the core logic code for dupeGuru. It's Python code.
|
||||
* 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.
|
||||
|
|
@ -64,23 +63,24 @@ git submodules:
|
|||
* 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.
|
||||
|
||||
# How to build dupeGuru from source
|
||||
## How to build dupeGuru from source
|
||||
|
||||
If you're on Linux or Mac, there's a bootstrap script that will make building very easy. There
|
||||
might be some things that you need to install manually on your system, but the bootstrap script will
|
||||
tell you when what you need to install. You can run the bootstrap with:
|
||||
There's a bootstrap script that will make building very easy. There might be some things that you
|
||||
need to install manually on your system, but the bootstrap script will tell you when what you need
|
||||
to install. You can run the bootstrap with:
|
||||
|
||||
./bootstrap.sh
|
||||
|
||||
and follow instructions from the script.
|
||||
|
||||
## Prerequisites installation
|
||||
### Prerequisites installation
|
||||
|
||||
Prerequisites are installed through `pip`. However, some of them are not "pip installable" and have
|
||||
to be installed manually.
|
||||
|
||||
* All systems: [Python 3.4+][python]
|
||||
* Mac OS X: The last XCode to have the 10.7 SDK included.
|
||||
* Linux: PyQt5
|
||||
|
||||
On Ubuntu (14.04+), the apt-get command to install all pre-requisites is:
|
||||
|
||||
|
|
@ -94,7 +94,7 @@ this with:
|
|||
|
||||
$ env PYTHON_CONFIGURE_OPTS="--enable-framework" pyenv install 3.4.3
|
||||
|
||||
## Setting up the virtual environment
|
||||
### Setting up the virtual environment
|
||||
|
||||
*This is done automatically by the bootstrap script. This is a reference in case you need to do it
|
||||
manually.*
|
||||
|
|
@ -114,7 +114,7 @@ For OS X:
|
|||
$ source env/bin/activate
|
||||
$ pip install -r requirements-osx.txt
|
||||
|
||||
## Actual building and running
|
||||
### Actual building and running
|
||||
|
||||
With your virtualenv activated, you can build and run dupeGuru with these commands:
|
||||
|
||||
|
|
@ -125,7 +125,7 @@ You can also package dupeGuru into an installable package with:
|
|||
|
||||
$ python package.py
|
||||
|
||||
# Running tests
|
||||
### Running tests
|
||||
|
||||
The complete test suite is ran with [Tox 1.7+][tox]. If you have it installed system-wide, you
|
||||
don't even need to set up a virtualenv. Just `cd` into the root project folder and run `tox`.
|
||||
|
|
|
|||
Loading…
Reference in New Issue