TapTap/FastSync
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: update README with --source-dir/--dest-dir/--save-to-disk and test.py

Browse Source
This commit is contained in:
TapTap
2026-07-04 22:57:58 +02:00
parent 1c5099b963
commit e7c23c135b
1 changed files with 18 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+18 -4
View File
@@ -49,15 +49,18 @@ The client-server communication uses the following status codes:
| `-m` | Enable multithreading mode |
| `-c [level]` | Enable compression with optional level (1-22, default: 5) |
| `-s` | Enable chunk serialization (batch-transfer all files per chunk) |
| `--source-dir <path>` | Source directory to sync (overrides `FASTSYNC_SOURCE_DIR`) |
| `--dest-dir <path>` | Server-side destination directory (overrides `FASTSYNC_DEST_DIR`) |
| `--save-to-disk` | Persist received files to disk |
### Environment Variables
| Variable | Description | Default |
|----------|-------------|---------|
| `FASTSYNC_SOURCE_DIR` | Source directory for files | Current user's documents directory |
| `FASTSYNC_DEST_DIR` | Destination directory | `./data_copied` |
| `FASTSYNC_SOURCE_DIR` | Source directory for files (fallback, overridden by `--source-dir`) | Current user's documents directory |
| `FASTSYNC_DEST_DIR` | Destination directory (fallback, overridden by `--dest-dir`) | `./data_copied` |
| `FASTSYNC_SERVER_IP` | Server IP address | `127.0.0.1` |
| `FASTSYNC_SERVER_PORT` | Server port | `8080` |
| `FASTSYNC_SAVE_TO_DISK` | Save to disk (true/false) | `false` |
| `FASTSYNC_SAVE_TO_DISK` | Save to disk (fallback, overridden by `--save-to-disk`) | `false` |
## Implementation Details
@@ -101,9 +104,12 @@ make
### Client
```bash
# Basic usage
# Basic usage with default settings (sends from ~/Documents/...)
./build/client -m -c 10
# Specify source and destination directories
./build/client --source-dir /path/to/send --dest-dir /path/to/receive --save-to-disk
# Chunk serialization mode (batch per chunk)
./build/client -s
@@ -122,6 +128,14 @@ The project includes comprehensive unit tests for core functionality:
./build/tests
```
An integration test / benchmark script runs all configurations against ~50 MB of generated test data with byte-for-byte verification:
```bash
python3 test.py
# Skip the throttled suite (disk I/O limits + 100ms network delay) if sudo is unavailable:
python3 test.py --no-throttled
```
## Code Organization
```