From 5e57b5f1193d18f88dc3064e66cb52ae07c1b133 Mon Sep 17 00:00:00 2001 From: glitchySid Date: Mon, 29 Dec 2025 21:09:10 +0530 Subject: [PATCH] added usage guide for --recursive flag --- README.md | 29 ++++++++++++++++++++++++++--- 1 file changed, 26 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index a2145eb..1832f27 100644 --- a/README.md +++ b/README.md @@ -38,9 +38,21 @@ NoEntropy is a smart command-line tool that organizes your cluttered Downloads f ## Installation +1. **Download Binary** + Download binary for your operating system(Windows, Linux or Mac) + ```bash + https://github.com/glitchySid/noentropy/releases + ``` +2. **Give Permisson(For Linux/Mac)** + ```bash + chmod +x binaryfilename + ``` + +## Run Locally + 1. **Clone repository** ```bash - git clone https://github.com/yourusername/noentropy.git + git clone https://github.com/glitchySid/noentropy.git cd noentropy ``` @@ -128,12 +140,23 @@ Use multiple options together: cargo run --release -- --dry-run --max-concurrent 3 ``` +### Recursive Mode + +Organize files in subdirectories recursively: + +```bash +cargo run --release -- --recursive +``` + +This scans all subdirectories within your download folder and organizes files from the entire directory tree, maintaining relative folder structure when creating categories. + ### Command-Line Options | Option | Short | Default | Description | |--------|-------|---------|-------------| -| `--dry-run` | None | `false` | Preview changes without moving files | -| `--max-concurrent` | None | `5` | Maximum concurrent API requests | +| `--dry-run` | `-d` | `false` | Preview changes without moving files | +| `--max-concurrent` | `-m` | `5` | Maximum concurrent API requests | +| `--recursive` | None | `false` | Recursively search files in subdirectories | | `--help` | `-h` | - | Show help message | ## How It Works