Skip to content

Commit 247271e

Browse files
authored
Update README.md
1 parent 8f33fd7 commit 247271e

1 file changed

Lines changed: 80 additions & 2 deletions

File tree

README.md

Lines changed: 80 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,80 @@
1-
# RoboCopy_GUI
2-
1+
diff --git a/d:\Projects\RoboCopy\README.md b/d:\Projects\RoboCopy\README.md
2+
new file mode 100644
3+
--- /dev/null
4+
+++ b/d:\Projects\RoboCopy\README.md
5+
@@ -0,0 +1,75 @@
6+
+# RoboCopy Pro
7+
+
8+
+A modern, glassmorphism Robocopy GUI for Windows with drag‑drop folders, live logs, presets, and high‑speed transfer options.
9+
+
10+
+## Highlights
11+
+- Drag & drop source and destination folders
12+
+- Clean copy/move modes with safe defaults
13+
+- Live Robocopy output with syntax highlighting
14+
+- Progress, ETA, and taskbar progress
15+
+- Presets for quick reuse
16+
+- Advanced options (threads, retries, wait, excludes)
17+
+- High‑speed toggle for maximum throughput
18+
+- Windows notifications on completion
19+
+
20+
+## Tech Stack
21+
+- React + Vite
22+
+- Tailwind CSS
23+
+- Electron (desktop shell)
24+
+
25+
+## Screenshots
26+
+Add your screenshots here:
27+
+- `docs/screenshot-main.png`
28+
+- `docs/screenshot-terminal.png`
29+
+
30+
+## Requirements
31+
+- Windows 10/11
32+
+- Node.js 18+ (recommended 20+)
33+
+
34+
+## Getting Started
35+
+```bash
36+
+npm install
37+
+npm run dev
38+
+```
39+
+
40+
+## Build (Portable EXE)
41+
+```bash
42+
+npm run build
43+
+npm run dist
44+
+```
45+
+The portable executable will be generated in `dist/`.
46+
+
47+
+## Usage
48+
+1. Drop a folder into **Source** and **Destination**.
49+
+2. Choose **Copy** or **Move**.
50+
+3. Adjust options (Mirror, Resume, Logging, etc.).
51+
+4. Click **Run Robocopy**.
52+
+
53+
+## Options (Quick Guide)
54+
+- **Mirror**: `/MIR` mirrors source to destination (deletes extras)
55+
+- **Resume**: `/Z` restartable mode (safer but slower)
56+
+- **High‑Speed**: minimizes output and disables slow options
57+
+- **Threads**: `/MT:n` parallel copy for faster I/O
58+
+- **Retries/Wait**: `/R:n /W:n` for locked files
59+
+- **Exclude**: `/XD /XF` (comma‑separated patterns)
60+
+
61+
+## Troubleshooting
62+
+**Blank window after build**
63+
+- Ensure `vite.config.js` uses `base: './'`
64+
+- In Electron, `loadFile` should point to built `dist/index.html`
65+
+
66+
+**Robocopy exit codes**
67+
+- Some non‑zero codes are warnings (not always failures)
68+
+- Check the live console output for details
69+
+
70+
+## Roadmap Ideas
71+
+- Recent paths
72+
+- Context‑menu integration
73+
+- Hash verification
74+
+- Richer presets
75+
+
76+
+## Disclaimer
77+
+Robocopy is powerful. **/MIR can delete files** in the destination. Use carefully.
78+
+
79+
+## License
80+
+MIT

0 commit comments

Comments
 (0)