Update README.md
This commit is contained in:
parent
7c2ebdaaa9
commit
c9ee704293
1 changed files with 62 additions and 1 deletions
63
README.md
63
README.md
|
|
@ -1 +1,62 @@
|
|||
# SherlyX
|
||||
# SherlyX
|
||||
|
||||

|
||||
|
||||
SherlyX is a rewritten and improved version of Sherly, which was originally written in Java. SherlyX is written in Go and features a user-friendly graphical user interface (GUI) for efficiently detecting and deleting duplicate files on your system. It's designed for speed and convenience.
|
||||
|
||||
For the original version of Sherly, you can visit [Sherly](https://github.com/BlyDoesCoding/Sherly).
|
||||
|
||||
## Table of Contents
|
||||
|
||||
- [Installation](#installation)
|
||||
- [Features](#features)
|
||||
- [Getting Started](#getting-started)
|
||||
- [Contributing](#contributing)
|
||||
- [License](#license)
|
||||
- [Acknowledgments](#acknowledgments)
|
||||
|
||||
## Installation
|
||||
|
||||
To get started with SherlyX, follow these installation steps:
|
||||
|
||||
1. Download the latest release from the [Releases](https://github.com/YourUsername/SherlyX/releases) page.
|
||||
2. Install the application on your system by following the platform-specific installation instructions.
|
||||
|
||||
## Features
|
||||
|
||||
SherlyX offers a range of features to help you manage duplicate files:
|
||||
|
||||
- Multithreaded scanning for faster detection.
|
||||
- User-friendly GUI for easy file management.
|
||||
- Efficient removal of all duplicate files.
|
||||
|
||||
## Getting Started
|
||||
|
||||
Follow these steps to get started with SherlyX:
|
||||
|
||||
1. Launch the SherlyX application on your system.
|
||||
2. Use the graphical interface to specify the folders or directories you want to scan for duplicate files.
|
||||
3. Click the "Start" or "Scan" button to begin the process.
|
||||
4. SherlyX will analyze the selected folders and present you with some intel.
|
||||
5. SherlyX will automatically delete all detected duplicate files.
|
||||
|
||||
SherlyX is designed for efficient and automated duplicate file management.
|
||||
|
||||
## Contributing
|
||||
|
||||
Contributions to SherlyX are welcome. If you want to contribute to this project, please follow these guidelines:
|
||||
|
||||
1. Fork the repository.
|
||||
2. Create a new branch for your feature or bug fix.
|
||||
3. Implement your changes and thoroughly test them.
|
||||
4. Submit a pull request, providing detailed information about your changes.
|
||||
|
||||
## License
|
||||
|
||||
SherlyX is open-source and released under the [BSD 3-Clause License](LICENSE). See the [LICENSE](LICENSE) file for details.
|
||||
|
||||
## Acknowledgments
|
||||
|
||||
We would like to express our gratitude to the Go community for their valuable resources and the open-source community for their support.
|
||||
|
||||
Thank you for choosing SherlyX to manage your duplicate files efficiently!
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue