Skip to content

Commit 6db7238

Browse files
committed
Updated README.md
1 parent 896c1b6 commit 6db7238

File tree

1 file changed

+32
-9
lines changed

1 file changed

+32
-9
lines changed

Arrange It/README.md

+32-9
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,41 @@
11
# Arrange It
22

3-
With the help of this script, files can be moved automatically to the folder that corresponds to their extension (for example, ".jpg" or ".png" ==> "/Pictures," and ".mp4" ==> "/Videos").
3+
With the help of this script, files can be moved automatically to the folder that corresponds to their extension (for example, .jpg or .png files go to the /Pictures folder, and .mp4 files go to /Videos).
44

5-
## How To Run
5+
## New Feature: Custom Folder Configuration
66

7-
- Put in Download Folder Or Wherever You want to automatically move the file and Just run
7+
-Now, you can customize how files are arranged by defining your own folder structure and file extensions using a config.json file. This allows for more flexibility without needing to modify the Python code itself.
8+
python arrangeit.py
9+
10+
# How To Use the config.json File
11+
12+
1. The config.json file contains the mappings of file extensions to folder names.
13+
2. You can modify, add, or remove folder categories and file extensions as per your needs.
14+
15+
Example config.json:
16+
17+
{
18+
"Programming Files": ["ipynb", "py", "java", "cs", "js"],
19+
"Music": ["mp3", "wav", "aac"],
20+
"Videos": ["mp4", "mkv", "avi"],
21+
"Pictures": ["jpeg", "png", "gif"],
22+
"Documents": ["pdf", "docx", "xlsx"]
23+
}
824

9-
For CLI
25+
# How To Run
26+
27+
Put the script and the config.json file in the folder where you want to automatically move the files.
28+
29+
Run the following command from the terminal:
1030

11-
```bash
1231
python arrangeit.py
1332

14-
<!-- This is a manual change to ensure the file is tracked and updated -->
15-
```
1633

17-
<!-- Updated README links and corrected typos -->
18-
<!-- Updated README links and corrected typos -->
34+
The script will create folders and move files based on the folder-extension mappings in the config.json file.
35+
36+
37+
# Benefits
38+
39+
Customizable: Easily modify the config.json file to tailor the organization to your preferences.
40+
User-Friendly: No need to modify Python code—just update the config.json file.
41+
Scalable: Works with different folder structures for different use cases.

0 commit comments

Comments
 (0)