From ff643d23f6bd1ab052aeb9fd44214dc467239f5d Mon Sep 17 00:00:00 2001 From: DigiJ Date: Wed, 11 Mar 2026 23:05:14 -0700 Subject: [PATCH] Update README with detailed feature list, architecture, and easter egg hints --- README.md | 153 ++++++++++++++++++++++++++++++++++++++++++++++++------ 1 file changed, 138 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index a829d88..7cc4320 100644 --- a/README.md +++ b/README.md @@ -1,30 +1,153 @@ # Setec Partition Wizard For Windows -A comprehensive disk recovery, repair, flashing, and formatting tool for Windows. +**A free, open-source disk utility that does everything the paid tools do — without the monthly subscription.** + +Tired of Acronis, EaseUS, and Partition Magic charging you $50/year for basic disk operations? So were we. Setec Partition Wizard is a comprehensive C++17/Qt6 disk utility covering partition management, formatting, recovery, imaging, diagnostics, security, and maintenance — all in one tool, completely free. + +[![VirusTotal Scan](https://i.ibb.co/TdDKXWb/virustotal.jpg)](https://ibb.co/GNfswHt) + +--- ## Features -- **Partition Management** — Create, delete, resize, move, merge, and split partitions -- **Formatting** — NTFS, FAT32/16/12, exFAT, ext2/3/4, Btrfs, XFS, HFS+, APFS (read), ReFS, and legacy filesystems (HPFS, Minix, AmigaFFS, BeOS BFS, and more) -- **Partition Tables** — Full MBR, GPT, and Apple Partition Map support -- **Recovery** — Deleted partition recovery, file carving, MBR/GPT repair -- **Imaging** — Disk/USB/SD card imaging, ISO flashing, disk cloning -- **Diagnostics** — S.M.A.R.T. monitoring, benchmarks, surface scan -- **Security Keys** — FIDO2/WebAuthn programming, encrypted vaults, boot authentication keys -- **Maintenance** — Secure erase (DoD 5220.22-M, Gutmann), boot repair +### Partition Management +- **Create, delete, resize, move, merge, and split** partitions with a visual disk map +- Full **MBR, GPT, and Apple Partition Map** support +- GParted-style **operation queue** — preview all changes before applying them +- Partition alignment optimization for SSDs and 4K sector drives +- Raw partition table editing for advanced users -## Building +### Formatting — Every Filesystem You Can Think Of +- **Modern:** NTFS, FAT32/16/12, exFAT, ReFS +- **Linux:** ext2/3/4, Btrfs, XFS, JFS, ReiserFS, Linux swap +- **Apple:** HFS+, APFS (read-only detection), HFS Classic +- **Legacy & Retro:** HPFS (OS/2), Minix, Amiga Fast File System, BeOS BFS, QNX4, UFS (BSD), Xenix, Coherent, SysV, ADFS (Acorn), UDF, ISO9660 +- **Special:** RomFS, CramFS, SquashFS, VFAT, UMSDOS + +Yes, we support filesystems from the 1980s. Because why not. + +### Recovery +- **Deleted partition recovery** — scans for lost MBR/GPT partition entries +- **File carving** — recovers files by signature from MFT records, FAT directories, ext inodes, and raw byte-pattern carving +- **Boot repair** — rebuilds MBR boot code, fixes Windows BCD, restores GPT backup headers +- Supports recovery across MBR, GPT, and ext superblock structures + +### Disk Imaging +- **Full disk imaging** — create and restore complete disk/partition images +- **ISO flashing** — write ISO/IMG files to USB drives and SD cards with hybrid ISO and UEFI boot detection +- **Disk cloning** — sector-by-sector or smart clone (skips unallocated space) +- **Checksum verification** — SHA-256, MD5, and CRC32 on all imaging operations + +### S.M.A.R.T. & Diagnostics +- **S.M.A.R.T. monitoring** for both ATA and NVMe drives — read all attributes, thresholds, and health status +- **Disk benchmarks** — sequential and random read/write, queue depth 1 and 32 +- **Surface scan** — find bad sectors before they eat your data + +### Security +- **FIDO2/WebAuthn** — enumerate connected security keys, manage PINs, factory reset, create/verify credentials via the Windows WebAuthn API +- **Encrypted vaults** — create AES-256 encrypted virtual disk containers (XTS, CBC, and GCM modes) with PBKDF2 key derivation +- **Boot authentication keys** — create USB-based HMAC-SHA256 tokens for application access control +- All cryptography uses **Windows CNG (BCrypt)** — zero external dependencies, no OpenSSL + +### Maintenance +- **Secure erase** — multiple wipe standards: + - Single-pass zero fill + - DoD 5220.22-M (3-pass and 7-pass variants) + - Gutmann 35-pass method + - Random fill and custom byte patterns +- **Boot repair** with MBR reconstruction and BCD rebuilding + +--- + +## Screenshots + +*Coming soon — the UI features a tabbed interface with visual disk maps, operation queues, and real-time progress tracking.* + +--- + +## System Requirements + +| Requirement | Details | +|-------------|---------| +| **OS** | Windows 10/11 x64 | +| **Privileges** | Administrator (required for raw disk access) | +| **Disk Space** | ~100 MB | +| **Runtime** | Qt 6 libraries (included in release builds) | + +--- + +## Building From Source ```bash -cmake --preset release -cmake --build --preset release +cmake --preset default +cmake --build --preset default ``` -Requires: +### Build Requirements - CMake 3.25+ -- Qt 6 +- Qt 6 (msvc2022_64 kit) - MSVC (Visual Studio 2022+) -- Windows 10/11 x64 +- Ninja (recommended, bundled with Qt) + +See [docs/build.md](docs/build.md) for detailed build instructions, troubleshooting, and architecture overview. + +--- + +## Architecture + +``` +src/ +├── core/ # spw_core static library +│ ├── common/ # Types, Result, Error, Constants, Logging +│ ├── disk/ # RawDiskHandle, VolumeHandle, DiskEnumerator, +│ │ # SmartReader, PartitionTable, FilesystemDetector +│ ├── filesystem/ # FormatEngine (all filesystem formatters) +│ ├── operations/ # GParted-style operation queue +│ ├── recovery/ # Partition recovery, file carving, boot repair +│ ├── diagnostics/ # Benchmarks, surface scan +│ ├── imaging/ # Disk cloner, image creator/restorer, ISO flasher +│ ├── maintenance/ # Secure erase +│ └── security/ # Encrypted vaults, FIDO2, boot auth +├── ui/ # spw_ui static library (Qt Widgets) +│ ├── MainWindow # Tab container with visual disk map +│ ├── tabs/ # One tab per feature area +│ └── widgets/ # DiskMapWidget (GParted-style visual partition map) +└── app/ # Executable entry point +``` + +### Design Decisions +- **No exceptions** — monadic `Result` error handling throughout +- **No OpenSSL** — all crypto via Windows BCrypt (CNG API) +- **RAII everything** — disk handles auto-close on destruction +- **Operation queue** — changes are queued, previewed, then applied atomically +- **Removable-only safety** — ISO flasher refuses to write to fixed disks +- **Admin required** — raw disk I/O requires elevation; app checks and prompts + +--- + +## A Note for the Curious + +> *"Don't forget to look UP UP at space."* + +Some say if you press **F5** while the application is running, something unexpected happens. Something involving a riddle about nothing, a dark void, and a very particular file that only your build can produce. + +Those who grew up cleaning floors on the SCS Deepship 86 might feel right at home. The janitor always did have a knack for finding hidden things. + +*Roger Wilco was here.* + +--- + +## Contributing + +Contributions are welcome! This project exists because security and disk management tools should be free and accessible to everyone. + +1. Fork the repository +2. Create a feature branch +3. Submit a pull request + +Please note: the `third_party/hwdiag/` module is distributed as a pre-compiled library. Source files for that module are not included in the repository. + +--- ## License