diff --git a/README.md b/README.md index bf2ef1e..eee264d 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,37 @@ # 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. -## Tech Stacks -- Python - Tkinter -- SQlite +## **Features** +* **File Organization:** + * Define rules to move files based on their extensions (e.g., move all `.txt` files to a "Documents" folder). + * Save and manage these rules persistently using a SQLite database. + * Organize files within a selected directory based on the defined rules. +* **File Renaming:** + * Select and rename individual files. + * Define patterns for renaming, including placeholders to dynamically insert parts of the original filename or extension. +* **Search:** + * Search for files within a specific directory. + +## **Requirements** +* Python 3.x +* Tkinter (included in most Python installations) +* sqlite (included in most Python installations) + +## **Installation** +No installation is required. You can run the script directly from your command line. + +## **Usage** +1. **Download:** Save the script `main.py` to your desired location. +2. **Run:** Open a terminal or command prompt, navigate to the directory where you saved the script, and run: + + ```bash + python main.py + +## Contributing +We welcome contributions to improve this project! Feel free to fork the repository and submit pull requests with your enhancements. + +## Communication Server +https://discord.gg/XsYcNdFm46 ## Project Admin - Ashwin Kumar R @@ -11,5 +39,8 @@ A tool that organizes files and folders based on pre-defined rules. This can sav ## Developer(s) - Ashwin Kumar R -## Communication Server -https://discord.gg/XsYcNdFm46 +## GitHub Topics +These topics help users discover relevant projects on GitHub: +Python, Tkinter, SQlite +file-management, file-organization, +file-renaming, gui