ChaoticByte/xxSherly
Archived
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Updaded readme and added compile instructions

Browse source
This commit is contained in:
bly 2023-05-04 21:14:41 +02:00
parent 08c727e62b
commit 45bab99e28
2 changed files with 41 additions and 41 deletions
Download patch file Download diff file Expand all files Collapse all files

56
README.md
View file

@ -1,14 +1,34 @@
# Sherly
![Bitbucket open issues](https://img.shields.io/bitbucket/issues/BlyDoesCoding/Sherly?style=for-the-badge) ![GitHub commit activity (branch)](https://img.shields.io/github/commit-activity/m/BlyDoesCoding/Sherly?style=for-the-badge) ![GitHub repo size](https://img.shields.io/github/repo-size/BlyDoesCoding/Sherly?style=for-the-badge) ![GitHub release (latest by date)](https://img.shields.io/github/v/release/BlyDoesCoding/Sherly?style=for-the-badge) ![GitHub all releases](https://img.shields.io/github/downloads/BlyDoesCoding/Sherly/total?style=for-the-badge) ![AUR version](https://img.shields.io/aur/version/sherly-git?style=for-the-badge)
## Introduction
# Sherly
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
```console
## Installation
Install via AUR
```bash
yay -S sherly-git
```
Compile yourself
```bash
git clone https://github.com/BlyDoesCoding/Sherly
cd Sherly
mkdir -p Bin
javac -d Bin src/*.java -Xlint
cd Bin
jar cfe sherly.jar Main ConsoleColors.class Main.class ThreadedCompare.class
#the jar file will be in the Bin Folder
```
## Usage/Examples
```bash
Usage: sherly -f inputfolder1 inputfolder2 inputfolder3 [options]...
-h / -help show this
-f / -folder all the folders you want to scan for (see example above!)
-c / -color enable colored messages
@ -17,26 +37,4 @@ Usage: sherly -f inputfolder1 inputfolder2 inputfolder3 [options]...
-d / -delete delete all dups except one without asking first
-debug debug stuff
```
## Installation
## Via AUR for Arch users
```console
yay -S sherly-git
#just replace yay with your aur helper of choise
```
## Any other OS
You can easily download the sherly.jar file from the releases tab and are able to execute it with the prefix "java --jar".
## Supported Platforms
| OS | Working | Version |
| :----: |:--------------:|:-------:|
| Linux | Yes | 1.1.2 |
| Windows 10/11/8/7 | Yes | 1.1.2 |
| BSD | Not yet Tested | X |
## Screenshots
![screenshot](https://github.com/BlyDoesCoding/Sherly/blob/master/Images/screenshot?raw=true)