diff --git a/README.md b/README.md index bf2ef1e..00f8d20 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,70 @@ # 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 Python application designed to organize files and folders automatically based on pre-defined rules. This tool aims to save time and effort spent on manually maintaining a clean desktop or file system. + +## Features + +- **File Organization:** Automatically sorts files and folders into designated directories according to user-defined rules. +- **Desktop Cleanup:** Keeps your desktop clutter-free by moving files to appropriate folders. +- **Custom Rules:** Define specific rules for organizing different types of files based on extensions, names, or other attributes. +- **User Interface:** Simple and intuitive Tkinter interface for easy configuration and usage. +- **Data Management:** Utilizes SQLite for efficient storage and retrieval of rules and configurations. ## 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. Run the script `main.py` to launch the application. +2. Define your file organization rules using the intuitive interface. +3. Click on "Organize" to let AutomaDesk automate the file organization process. +4. Enjoy a clutter-free desktop and well-organized file system! + +## Contributing + +Contributions are welcome! If you have suggestions, feature requests, or bug reports, please [open an issue](https://github.com/Ash515/AutomaDesk/issues) or submit a pull request. + +## License + +This project is licensed under the MIT License. + +## 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 using gmail. + +--- + +Feel free to customize this README template further according to your project's specific details and requirements.