RustyFilesort

Automatically sort your downloads folder with Rust

· Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
   • Features
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

RustyFilesort is a tool to automatically organize your downloads folder using Rust. It helps keep your files sorted and easy to find.

(back to top)

Built With

(back to top)

Features

• Asynchronous sorting of files in the download directory

• Automatic directory creation for file extensions

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

• Rust

  curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

Installation

1. Clone the repo

   git clone https://github.com/LowPolyCat1/RustyFilesort

2. Build the project

   cargo build --release

3. Run the executable

   ./target/release/autosort_downloads

(back to top)

Usage

Use RustyFilesort to keep your downloads folder organized automatically. Simply run the executable and let it sort your files based on predefined rules.

(back to top)

Roadmap

• Add support for custom sorting rules
• Implement a GUI
• Asynchronous Sorting
• Support for multiple folders
• Scheduling support
• Config files
• Automatic binary updating

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

Top contributors

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

LowPolyCat1 - @LowPolyCat1 - Juliantepper2006+github@gmail.com

Project Link: https://github.com/LowPolyCat1/RustyFilesort

(back to top)

Acknowledgments

• othneildrew for making this readme template

(back to top)