Skip to content

Commit c929cb6

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

1 file changed

Lines changed: 75 additions & 80 deletions

File tree

README.md

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

0 commit comments

Comments
 (0)