Skip to content

Commit

Permalink
feat: Updated README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
sweep-ai[bot] committed Feb 16, 2024
1 parent cacd19a commit d5f7de1
Showing 1 changed file with 44 additions and 1 deletion.
45 changes: 44 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Duplicate-File-Finder
# Duplicate and Large File Finder

A command-line utility for identifying and managing duplicate files.

Expand All @@ -14,6 +14,18 @@ Duplicate-File-Finder is a utility designed to help you declutter your storage b
## Installation & Prerequisites

Golang (if you plan to run the source code directly)
## Table of Contents
- [Description](#description)
- [Features](#features)
- [Duplicate File Finder](#duplicate-file-finder)
- [Large File Finder](#large-file-finder)
- [Installation & Prerequisites](#installation--prerequisites)
- [Duplicate File Finder](#duplicate-file-finder-1)
- [Large File Finder](#large-file-finder-1)
- [Usage](#usage)
- [Duplicate File Finder](#duplicate-file-finder-2)
- [Large File Finder](#large-file-finder-2)
- [Contributing](#contributing)
Option 1: Running from Source

Clone this repository:
Expand All @@ -31,6 +43,10 @@ go run main.go
```
Option 2: Using the Compiled Executable

Download the pre-compiled executable (main.exe for Windows) the [Releases](https://github.com/lilsheepyy/Duplicate-File-Finder/releases/tag/Executable) section of this repository.
Place the executable in your desired location.
Usage
## Features
Download the pre-compiled executable (main.exe for Windows) the [Releases](https://github.com/lilsheepyy/Duplicate-File-Finder/releases/tag/Executable) section of this repository.
Place the executable in your desired location.
Usage
Expand All @@ -44,6 +60,22 @@ Example:
```bash
main.exe C:\Users\ExampleUser\Documents
```
## Installation & Prerequisites
### Large File Finder
No additional prerequisites are required beyond those needed for the Duplicate File Finder.

Option 1: Running from Source
Clone this repository and navigate to the `largefilefinder` directory:
```bash
cd largefilefinder
```
Run the application:
```bash
go run main.go
```
Option 2: Using the Compiled Executable
Download the pre-compiled executable for the Large File Finder from the [Releases](https://github.com/lilsheepyy/Duplicate-File-Finder/releases/tag/Executable) section.
```
## Output
The utility will print a list of any discovered duplicate file groups, indicating the file paths within each group.
Expand All @@ -54,3 +86,14 @@ Contributions to improve Duplicate-File-Finder are welcome! Please follow these
* Fork this repository.
* Create a branch for your changes.
* Submit a pull request with a detailed description of your contributions.
### Large File Finder
Basic Usage:
```bash
main.exe --dir (Path to directory) --size (Minimum file size)
```
Replace `(Path to directory)` with the actual path to the directory you want to scan for large files, and `(Minimum file size)` with the size threshold (e.g., `500MB`).

Example:
```bash
main.exe --dir C:\Users\ExampleUser\Documents --size 100MB
```

0 comments on commit d5f7de1

Please sign in to comment.