From 619a8f233fec680ebe12b338b0ce38c373832698 Mon Sep 17 00:00:00 2001 From: hasmithagunda123 <100082565+hasmithagunda123@users.noreply.github.com> Date: Tue, 14 May 2024 10:04:29 +0530 Subject: [PATCH] Update README.md --- README.md | 73 ++++++++++++++++++++++++++++++++++++++++++++++++++----- 1 file changed, 67 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index bf2ef1e..204d0ee 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,76 @@ # AutomaDesk -A tool that organizes files and folders based on pre-defined rules. This can save time and effort spent on manually maintaining a clean desktop. + +AutomaDesk is a desktop automation tool designed to organize files and folders based on pre-defined rules. This tool aims to save time and effort spent on manually maintaining a clean desktop environment. + +## About + +AutomaDesk automates the process of organizing files and folders on your desktop or in specified directories. By defining rules for file organization, users can streamline the management of their digital files and improve productivity. + +## Features + +- **File Organization:** Automatically sorts files and folders into designated directories based on pre-defined rules. +- **Rule Management:** Add, edit, and delete rules for organizing files by file type, name, or other attributes. +- **User Interface:** Simple and intuitive graphical user interface (GUI) built with Python and Tkinter. +- **Database Integration:** Utilizes SQLite database for storing and managing file organization rules. +- **Customization:** Flexible and customizable to suit individual preferences and workflow. ## Tech Stacks -- Python - Tkinter -- SQlite + +- **Python:** Primary programming language used for development. +- **Tkinter:** Python's standard GUI library for building the user interface. +- **SQLite:** Lightweight and easy-to-use relational database management system. ## Project Admin -- Ashwin Kumar R + +- **Ashwin Kumar R** ## Developer(s) -- Ashwin Kumar R + +- **Ashwin Kumar R** ## Communication Server -https://discord.gg/XsYcNdFm46 + +Join our Discord server for discussions, support, and updates: [AutomaDesk Discord Server](https://discord.gg/XsYcNdFm46) + +## Installation + +1. Clone the repository: + + ```bash + git clone https://github.com/Ash515/AutomaDesk.git + ``` + +2. Install dependencies: + + ```bash + pip install -r requirements.txt + ``` + +## Usage + +1. Launch the application by running `main.py`. +2. Define rules for file organization by specifying file types and destination folders. +3. Click on "Save Rule" to save the rule to the database. +4. Click on "Organize Files" to automatically organize files based on the defined rules. +5. Use the search functionality to find files containing specific terms within the source directory. +6. Enjoy a clutter-free desktop and improved file management! + +## Contributing + +Contributions are welcome! If you have suggestions, feature requests, or bug reports, please feel free to [open an issue](https://github.com/Ash515/AutomaDesk/issues) or submit a pull request. + +## License + +This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. + +## Acknowledgements + +Special thanks to all contributors and the open-source community for their valuable contributions and support. + +## Support + +For support or inquiries, please contact the project maintainer at [ashwinkumar.r.2020@gmail.com](mailto:ashwinkumar.r.2020@gmail.com). + +--- + +Feel free to adjust any details or sections according to your preferences and project requirements.