From 6e389e62d381f65602a890f03b32bcd41ad983d9 Mon Sep 17 00:00:00 2001 From: Chris Xiong Date: Tue, 30 Aug 2022 20:20:39 -0400 Subject: Add proper readme and license. --- README.md | 24 +++++++++++++++++++++--- 1 file changed, 21 insertions(+), 3 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 0953789..2dedcf2 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,25 @@ # Deduper -(take two) +Deduper finds you similar images on your local filesystem. -still a work in progress +Deduper ... -license tbd. all rights reserved atm. +- finds similar images, regardless of differences in dimensions and compression artifects. +- does pretty much the same thing as [libpuzzle](https://github.com/jedisct1/libpuzzle). +- is an implementation of the same article as libpuzzle. +- uses fast routines provided by OpenCV whenever possible. +- is up to 3 times faster than libpuzzle *. +- provides a tool to manage duplicate images on your local filesystem efficiently. +- has an image indexer to provide fast reverse image searching locally **. +- has a C++ API that provides low level and high level functionalities. + +*: When using a sub-sliced, signature hash assisted implementation to search for +duplicate images in a dataset containing 4000 images, against a plain, distance +comparing implementation. Both implementations are multi-threaded, run on a dual +core mobile processor with hyperthreading. + +**: Planned. + +## License + +Mozilla Public License 2.0 -- cgit v1.2.3