[elpa] externals/dired-duplicates 03ad95f3a9 31/57: Add README.org

[ELPA Syncer]

branch: externals/dired-duplicates
commit 03ad95f3a9375a6335529c0b0fdd880faf36c76e
Author: Harald Judt <h.judt@gmx.at>
Commit: Harald Judt <h.judt@gmx.at>

    Add README.org
---
 README.org | 40 ++++++++++++++++++++++++++++++++++++++++
 1 file changed, 40 insertions(+)

diff --git a/README.org b/README.org
new file mode 100644
index 0000000000..f04d3e18b6
--- /dev/null
+++ b/README.org
@@ -0,0 +1,40 @@
+#+title: find-duplicates - Find duplicate files on local and remote filesystems
+
+* Description
+This Emacs package helps to find duplicate files on local and remote
+filesystems.  It is similar to the fdupes command-line utility but written in
+Emacs Lisp and should also work on every remote filesystem that TRAMP supports
+and where executable commands can be called remotely.
+
+find-duplicates works by first searching files of the same size, then invoking
+the calculation of the checksum for these files, and finally presenting the
+grouped results in a Dired buffer that the user can work with similarly to a
+regular Dired buffer.  It might be even possible to combine this with other
+Dired extension packages, like =dired-narrow=.  The results will be grouped
+visually by using a temporary file serving as a separator.
+
+* Requirements
+For performance reasons, a checksum program like =md5= or =sha256sum= will be
+used for generating checksums of file contents and therefore needs to be
+available and executable on the local and/or remote hosts. The name of the
+checksum program can be customized.
+
+* Installation
+The package can be installed via the Emacs package manager,
+e.g. ~package-install~.  Or you use the following use-package snippet:
+#+BEGIN_SRC emacs-lisp
+(use-package find-duplicates)
+#+END_SRC
+
+* Usage
+Call ~find-duplicates-dired~ interactively and provide one or more directories
+(usually separated by commas) to search in recursively.
+
+* Configuration
+You can find all available customization options with ~customize-group~,
+entering =find-duplicates= for the desired group.  These options are described
+extensively there.
+
+* License
+This package is licensed under GPL-3. See the =LICENSE= file for more
+information.