Updated and improved the README

This commit is contained in:
Julian Müller (ChaoticByte) 2023-05-06 00:05:28 +02:00
parent b4b5a766f8
commit 67516a6217
3 changed files with 27 additions and 7 deletions

Binary file not shown.

Before

Width:  |  Height:  |  Size: 66 KiB

View file

@ -2,11 +2,16 @@
A fork of [Sherly](https://github.com/BlyDoesCoding/Sherly), using [xxHash](https://github.com/Cyan4973/xxHash).
![](./images/screenshot.png)
## Introduction
Sherly is a Multithreaded Duplicate File Finder for your Terminal, written in java. You can Easily find duplicate Images, videos as well as any other type of Data. That can be helpful if you run on small storage or just want to keep regular housekeeping.
## Full Usages
This fork uses [xxHash](https://github.com/Cyan4973/xxHash) instead of MD5 for performance reasons (see [Speed comparison](#speed-comparison)).
Note that xxHash is not a cryptographic hash function and therefore may produce collisions. That's why the checksum is composed of the xxHash Digest and the filesize.
## Usage
```console
Usage: sherly -f inputfolder1 inputfolder2 inputfolder3 [options]...
@ -30,11 +35,26 @@ mvn package assembly:single
## Supported Platforms
| OS | Working | Version |
| :----: |:--------------:|:-------:|
| Linux | Yes | 1.0 |
| Windows 10/11/8/7 | Not yet tested | |
| BSD | Not yet tested | |
| ----------------- | :------------: | ------: |
| Linux | Yes | 1.0 |
| Windows 10/11 | Not yet tested | - |
| macOS | Not yet tested | - |
| BSD | Not yet tested | - |
## Screenshots
## Speed comparison
![screenshot](https://github.com/BlyDoesCoding/Sherly/blob/master/Images/screenshot?raw=true)
I let Sherly and xxSherly find duplicates in my Music Library (containing `.wav` files) using the following commands:
```bash
time java -jar Bin/sherly.jar -n -f ~/Music/ /usr/lib
time java -jar target/xxSherly-1.0-jar-with-dependencies.jar -n -f ~/Music/ /usr/lib
```
The timings are measured using the Linux tool `time` (`real`).
| | Sherly | xxSherly |
| --------: | ------------: | --------------: |
| 1st run | 4.055s | 2.561s |
| 2nd run | 4.055s | 2.304s |
| 3rd run | 4.066s | 2.549s |
| **avg** | **4.059s** | **2.471s** |

BIN
images/screenshot.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 54 KiB