Updaded readme and added compile instructions
This commit is contained in:
parent
08c727e62b
commit
45bab99e28
2 changed files with 41 additions and 41 deletions
26
.idea/workspace.xml
generated
26
.idea/workspace.xml
generated
|
@ -11,7 +11,7 @@
|
|||
<component name="ChangeListManager">
|
||||
<list default="true" id="9b57ac51-c870-474b-9dfd-64a5fc490635" name="Changes" comment="Removed whitespaces and changed comments">
|
||||
<change beforePath="$PROJECT_DIR$/.idea/workspace.xml" beforeDir="false" afterPath="$PROJECT_DIR$/.idea/workspace.xml" afterDir="false" />
|
||||
<change beforePath="$PROJECT_DIR$/src/Main.java" beforeDir="false" afterPath="$PROJECT_DIR$/src/Main.java" afterDir="false" />
|
||||
<change beforePath="$PROJECT_DIR$/README.md" beforeDir="false" afterPath="$PROJECT_DIR$/README.md" afterDir="false" />
|
||||
</list>
|
||||
<option name="SHOW_DIALOG" value="false" />
|
||||
<option name="HIGHLIGHT_CONFLICTS" value="true" />
|
||||
|
@ -34,6 +34,7 @@
|
|||
<option value="Lia Brueggemann <brueggemann.l@proton.me>" />
|
||||
</list>
|
||||
</option>
|
||||
<option name="RECENT_GIT_ROOT_PATH" value="$PROJECT_DIR$" />
|
||||
</component>
|
||||
<component name="GithubPullRequestsUISettings">
|
||||
<option name="selectedUrlAndAccountId">
|
||||
|
@ -52,18 +53,19 @@
|
|||
<option name="hideEmptyMiddlePackages" value="true" />
|
||||
<option name="showLibraryContents" value="true" />
|
||||
</component>
|
||||
<component name="PropertiesComponent">{
|
||||
"keyToString": {
|
||||
"RunOnceActivity.OpenProjectViewOnStart": "true",
|
||||
"RunOnceActivity.ShowReadmeOnStart": "true",
|
||||
"SHARE_PROJECT_CONFIGURATION_FILES": "true",
|
||||
"last_opened_file_path": "/home/bly/IdeaProjects/Sherly",
|
||||
"project.structure.last.edited": "Artifacts",
|
||||
"project.structure.proportion": "0.15",
|
||||
"project.structure.side.proportion": "0.2",
|
||||
"settings.editor.selected.configurable": "Settings.Markdown"
|
||||
<component name="PropertiesComponent"><![CDATA[{
|
||||
"keyToString": {
|
||||
"RunOnceActivity.OpenProjectViewOnStart": "true",
|
||||
"RunOnceActivity.ShowReadmeOnStart": "true",
|
||||
"SHARE_PROJECT_CONFIGURATION_FILES": "true",
|
||||
"git-widget-placeholder": "master",
|
||||
"last_opened_file_path": "/home/bly/IdeaProjects/Sherly",
|
||||
"project.structure.last.edited": "Artifacts",
|
||||
"project.structure.proportion": "0.15",
|
||||
"project.structure.side.proportion": "0.2",
|
||||
"settings.editor.selected.configurable": "preferences.pluginManager"
|
||||
}
|
||||
}</component>
|
||||
}]]></component>
|
||||
<component name="RunAnythingCache">
|
||||
<option name="myCommands">
|
||||
<command value="github" />
|
||||
|
|
56
README.md
56
README.md
|
@ -1,14 +1,34 @@
|
|||
# Sherly
|
||||
|
||||
     
|
||||
|
||||
## 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
|
||||

|
||||
|
|
Reference in a new issue