https://github.com/lowpolycat1/rustyfilesort
RustyFilesort is a tool to automatically organize your downloads folder using Rust. It helps keep your files sorted and easy to find.
https://github.com/lowpolycat1/rustyfilesort
file filesorter rust rust-lang sorting
Last synced: 3 months ago
JSON representation
RustyFilesort is a tool to automatically organize your downloads folder using Rust. It helps keep your files sorted and easy to find.
- Host: GitHub
- URL: https://github.com/lowpolycat1/rustyfilesort
- Owner: LowPolyCat1
- License: mit
- Created: 2025-01-02T18:39:12.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2025-01-02T23:30:50.000Z (5 months ago)
- Last Synced: 2025-01-17T09:12:21.939Z (5 months ago)
- Topics: file, filesorter, rust, rust-lang, sorting
- Language: Rust
- Homepage:
- Size: 22 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: license.txt
Awesome Lists containing this project
README
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![project_license][license-shield]][license-url]
Table of Contents
## 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.
### Built With
[![Rust][Rust]][Rust-url]
## 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
```sh
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
```
### Installation
1. Clone the repo
```sh
git clone https://github.com/LowPolyCat1/RustyFilesort
```
2. Build the project
```sh
cargo build --release
```
3. Run the executable
```sh
./target/release/autosort_downloads
```
## Usage
Use RustyFilesort to keep your downloads folder organized automatically. Simply run the executable and let it sort your files based on predefined rules.
## Roadmap
* [ ] Add support for custom sorting rules
* [ ] Implement a GUI | _very basic UI implemented so far_
* [x] Asynchronous Sorting
* [ ] Support for multiple folders
* [ ] Scheduling support
* [ ] Config files
* [ ] Automatic binary updating
* [ ] Autorun on startup | _known bug with crate [auto_run](https://github.com/zzzgydi/auto-launch/issues/10)_
See the [open issues](https://github.com/LowPolyCat1/RustyFilesort/issues) for a full list of proposed features (and known issues).
## 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
### Top contributors
## License
Distributed under the MIT License. See `LICENSE.txt` for more information.
## Contact
LowPolyCat1 - [@LowPolyCat1](https://twitter.com/LowPolyCat1) -
Project Link: [https://github.com/LowPolyCat1/RustyFilesort](https://github.com/LowPolyCat1/RustyFilesort)
## Acknowledgments
* [othneildrew](https://github.com/othneildrew/Best-README-Template) for making this readme template
[contributors-shield]: https://img.shields.io/github/contributors/LowPolyCat1/autosort_downloads.svg?style=for-the-badge
[contributors-url]: https://github.com/LowPolyCat1/RustyFilesort/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/LowPolyCat1/autosort_downloads.svg?style=for-the-badge
[forks-url]: https://github.com/LowPolyCat1/RustyFilesort/network/members
[stars-shield]: https://img.shields.io/github/stars/LowPolyCat1/autosort_downloads.svg?style=for-the-badge
[stars-url]: https://github.com/LowPolyCat1/RustyFilesort/stargazers
[issues-shield]: https://img.shields.io/github/issues/LowPolyCat1/autosort_downloads.svg?style=for-the-badge
[issues-url]: https://github.com/LowPolyCat1/RustyFilesort/issues
[license-shield]: https://img.shields.io/github/license/LowPolyCat1/RustyFilesort.svg?style=for-the-badge
[license-url]: https://github.com/LowPolyCat1/RustyFilesort/blob/main/license.txt
[Rust]: https://img.shields.io/badge/rust-000000?style=for-the-badge&logo=rust&logoColor=white
[Rust-url]: https://www.rust-lang.org/
