Skip to content

Commit 34970e6

Browse files
emylfyemylfy
committed
docs: README rewrite, version test fix
- Rewrote README — centered layout, badges, anchor nav, collapsible feature sections with tables - Consolidated compatibility table, updated footer - Updated version test to accept `YY.M.patch` format
1 parent a22ba2c commit 34970e6

File tree

3 files changed

+213
-67
lines changed

3 files changed

+213
-67
lines changed

‎CHANGELOG.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,14 @@ All notable changes to this project will be documented in this file.
55
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
66
and this project uses [Calendar Versioning](https://calver.org/) (YY.M.patch format).
77

8+
## [26.3.17] - 2026-03-26
9+
10+
### README rewrite
11+
12+
- Rewrote README — centered layout, badges, anchor nav, collapsible feature sections with tables
13+
- Consolidated compatibility table, updated footer
14+
- Updated version test to accept `YY.M.patch` format
15+
816
## [26.3.16] - 2026-03-26
917

1018
### Menu polish, README cleanup, health score fix

‎README.md‎

Lines changed: 203 additions & 65 deletions
Original file line numberDiff line numberDiff line change
@@ -1,87 +1,189 @@
1+
<div align="center">
2+
13
# Winrift
24

3-
**Break through default Windows.** Measure every tweak, prove every change — 13 system metrics, before and after.
5+
**Benchmark-driven Windows 11 optimization toolkit — tweak, customize**
46

5-
<p align="center">
6-
<img src="media/screenshot-main.png" alt="Winrift main menu" width="80%">
7-
</p>
7+
<a href="https://github.com/emylfy/winrift/stargazers"><img src="https://img.shields.io/github/stars/emylfy/winrift?style=for-the-badge&logo=starship&color=C9CBFF&logoColor=C9CBFF&labelColor=302D41" alt="GitHub Stars"></a>&nbsp;&nbsp;
8+
<a href="https://github.com/emylfy/winrift/blob/main/LICENSE"><img src="https://img.shields.io/github/license/emylfy/winrift?style=for-the-badge&logo=apache&color=CBA6F7&logoColor=CBA6F7&labelColor=302D41&label=License" alt="GitHub License"></a>&nbsp;&nbsp;
9+
<a href="https://github.com/emylfy/winrift/commits/main/"><img src="https://img.shields.io/github/last-commit/emylfy/winrift?style=for-the-badge&logo=github&logoColor=eba0ac&label=Last%20Commit&labelColor=302D41&color=eba0ac" alt="Last Commit"></a>&nbsp;&nbsp;
10+
<a href="https://github.com/emylfy/winrift/releases"><img src="https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fraw.githubusercontent.com%2Femylfy%2Fwinrift%2Fmain%2Fconfig%2Fversion.json&query=%24.version&prefix=v&style=for-the-badge&label=Version&color=a6e3a1&labelColor=302D41" alt="Version"></a>
811

9-
<div align="center">
10-
<p>
11-
<a href="https://github.com/emylfy/winrift/stargazers"><img src="https://img.shields.io/github/stars/emylfy/winrift?style=for-the-badge&logo=starship&color=C9CBFF&logoColor=C9CBFF&labelColor=302D41" alt="GitHub Stars"></a>&nbsp;&nbsp;
12-
<a href="https://github.com/emylfy/winrift/blob/main/LICENSE"><img src="https://img.shields.io/github/license/emylfy/winrift?style=for-the-badge&logo=apache&color=CBA6F7&logoColor=CBA6F7&labelColor=302D41&label=License" alt="GitHub License"></a>&nbsp;&nbsp;
13-
<a href="https://github.com/emylfy/winrift/commits/main/"><img src="https://img.shields.io/github/last-commit/emylfy/winrift?style=for-the-badge&logo=github&logoColor=eba0ac&label=Last%20Commit&labelColor=302D41&color=eba0ac" alt="Last Commit"></a>&nbsp;&nbsp;
14-
<a href="https://github.com/emylfy/winrift/releases"><img src="https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fraw.githubusercontent.com%2Femylfy%2Fwinrift%2Fmain%2Fconfig%2Fversion.json&query=%24.version&prefix=v&style=for-the-badge&label=Version&color=a6e3a1&labelColor=302D41" alt="Version"></a>
15-
</p>
16-
</div>
12+
<img src="media/screenshot-main.png" alt="Winrift terminal interface main menu" width="90%">
1713

18-
<p align="center">
19-
<a href="#install">Install</a> •
20-
<a href="#benchmark--dont-trust-verify">Benchmark</a> •
21-
<a href="#features">Features</a> •
22-
<a href="#compatibility">Compatibility</a>
23-
</p>
14+
</div>
2415

25-
> **No other tool covers this complete pipeline:** Measure → Optimize → Verify → Customize
16+
<h6 align="center">
17+
<a href="#quick-start">Quick Start</a> ·
18+
<a href="#features">Features</a> ·
19+
<a href="#benchmark">Benchmark</a> ·
20+
<a href="#health-score">Health Score</a> ·
21+
<a href="#compatibility">Compatibility</a>
22+
</h6>
2623

2724
---
2825

29-
## Install
26+
<a id="quick-start"></a>
3027

31-
Open PowerShell as Admin (`Win + X` → Terminal Admin) and run:
28+
## ⚡ Quick Start
29+
30+
Open PowerShell as admin — <kbd>Win</kbd> + <kbd>X</kbd> → Terminal Admin:
3231

3332
```powershell
3433
irm https://raw.githubusercontent.com/emylfy/winrift/main/scripts/launch.ps1 | iex
3534
```
3635

37-
A restore point is created automatically before any system changes.
36+
> [!NOTE]
37+
> A system restore point is created automatically before any changes. Every registry modification is backed up to JSON for rollback.
3838
3939
<details>
40-
<summary>Create a persistent Start Menu shortcut</summary>
40+
<summary><strong>Pin shortcut to Start Menu</strong></summary>
41+
42+
<br>
4143

4244
```powershell
4345
irm https://raw.githubusercontent.com/emylfy/winrift/main/scripts/install.ps1 | iex
4446
```
4547

4648
</details>
4749

48-
> **Security note:** This is a common PowerShell install pattern (similar to `curl | sh`). The full source code is open at [github.com/emylfy/winrift](https://github.com/emylfy/winrift). All external scripts are verified with SHA256 hashes before execution.
50+
> **Security note:** This is a common PowerShell install pattern (similar to `curl | sh`). The full source code is open at [github.com/emylfy/winrift](https://github.com/emylfy/winrift). Most external scripts are verified with SHA256 hashes before execution.
4951
5052
---
5153

52-
## Benchmark — Don't Trust, Verify
54+
<a id="features"></a>
5355

54-
Other tools apply tweaks and hope for the best. Winrift measures 13 system metrics before and after — so you see exactly what changed.
56+
## 🧩 Features
5557

56-
> Typical results on clean Windows 11 24H2 (your numbers will vary):
58+
<p align="center">
59+
<img src="media/screenshot-features.png" alt="Winrift features" width="80%">
60+
</p>
5761

58-
| Running processes | 142 | 98 | -31% |
62+
| | Feature | What it does |
63+
| :-- | :--------------------------------------------- | :----------------------------------------------------------------------------- |
64+
| 📊 | [**Benchmark**](docs/tests.md) | 13 metrics before & after, Markdown reports |
65+
| 🩺 | [**Health Score**](docs/health_score.md) | 0–100 rating, delta tracking, recommendations |
66+
| ⚙️ | [**System Tweaks**](docs/tweaks_guide.md) | 13 categories — latency, SSD, GPU, network, power, memory, DirectX |
67+
| 🔄 | [**Drift Detection**](docs/drift_detection.md) | Catches Windows Update reverting your tweaks; one-click reapply |
68+
| 🛡️ | **Security & Privacy** | Defender, Copilot/Recall removal, privacy hardening |
69+
| 🖥️ | **Drivers** | NVIDIA · AMD · Intel + 11 OEM manufacturers |
70+
| 🎨 | [**Customize**](modules/customize/README.md) | Desktop, terminal, editors, app themes — all without admin |
71+
| 📦 | **App Bundles** | 7 curated collections via [UniGetUI](https://github.com/marticliment/UniGetUI) |
72+
| 💿 | [**ISO Builder**](docs/autounattend_guide.md) | Embed answer file into Windows 11 ISO for automated install |
5973

60-
<sub>Full methodology and metric explanations: <a href="docs/tests.md">Testing & Benchmarks Guide</a></sub>
74+
<br>
6175

62-
---
76+
<details>
77+
<summary><strong>⚙️ System Tweaks — all 13 categories</strong></summary>
6378

64-
## Features
79+
<br>
6580

66-
<p align="center">
67-
<img src="media/screenshot-features.png" alt="Winrift features">
68-
</p>
81+
Every tweak is backed up before applying. Choose individually or apply all.
82+
83+
| # | Category | Risk | What it does |
84+
| --: | :------------- | :--: | :----------------------------------------------- |
85+
| 1 | System Latency | 🟡 | Interrupt steering, timer serialization |
86+
| 2 | Input Devices | 🟢 | Queue sizes, sticky/filter keys, input delays |
87+
| 3 | SSD / NVMe | 🟢 | TRIM, defrag, last access, 8.3 names, prefetcher |
88+
| 4 | GPU Scheduling | 🟡 | Hardware scheduling, preemption |
89+
| 5 | Network | 🟢 | Network throttling, lazy mode |
90+
| 6 | CPU | 🟢 | MMCSS, multimedia scheduler |
91+
| 7 | Power | 🟡 | C-states, PCIe ASPM, Ultimate Performance plan |
92+
| 8 | Responsiveness | 🟢 | Program priority, IRQ optimization |
93+
| 9 | Boot | 🟢 | Startup delays, desktop switch timeout |
94+
| 10 | UI | ⚠️ | Auto-end tasks, hung app timeout, menu delay |
95+
| 11 | Memory | 🟡 | Large system cache (16 GB+), page combining |
96+
| 12 | Maintenance | 🔧 | Automatic maintenance, I/O counting |
97+
| 13 | DirectX | ⚠️ | D3D12/D3D11 optimizations, multithreading |
98+
99+
GPU-specific tweaks are auto-detected:
100+
101+
- **NVIDIA** — per-CPU core DPC optimization
102+
- **AMD** — 40+ tweaks including power gating, color depth, latency
103+
104+
</details>
69105

70-
| Feature | What it does |
71-
| :--------------------------------------------- | :---------------------------------------------------------------------------------------------------- |
72-
| **[Benchmark](docs/tests.md)** | Measure 13 system metrics before and after tweaks |
73-
| **[Health Score](docs/health_score.md)** | 0-100 system rating across 7 categories with delta tracking and recommendations |
74-
| **[System Tweaks](docs/tweaks_guide.md)** | 13 optimization categories — latency, input, SSD, GPU, network, CPU, power, boot, UI, memory, DirectX |
75-
| **[Drift Detection](docs/drift_detection.md)** | Monitors whether Windows Updates revert tweaks; auto-check; one-click reapply |
76-
| **GPU Tweaks** | NVIDIA and AMD optimizations with automatic device detection |
77-
| **Security & Privacy** | Disable Defender, remove Copilot/Recall, privacy hardening |
78-
| **Drivers** | NVIDIA, AMD, Intel DSA + 9 OEM manufacturers |
79-
| **[Customize](modules/customize/README.md)** | Desktop environment, terminal configs, editor configs, app themes |
80-
| **App Bundles** | 7 winget collections via [UniGetUI](https://github.com/marticliment/UniGetUI) |
81-
| **[ISO Builder](docs/autounattend_guide.md)** | Embed answer file into Windows 11 ISO for automated clean installs |
106+
<details>
107+
<summary><strong>🔄 Drift Detection — keep tweaks applied</strong></summary>
108+
109+
<br>
110+
111+
Windows Updates silently revert registry changes. Drift Detection catches this.
112+
113+
- Tracks every applied tweak in a desired-state JSON
114+
- Compares current registry against desired state
115+
- Reports each entry as **OK** · **Drifted** · **Missing**
116+
- One-click reapply for all drifted values
117+
- Optional scheduled task runs automatically after updates
118+
119+
<sub>→ <a href="docs/drift_detection.md">Drift Detection Guide</a></sub>
120+
121+
</details>
82122

83123
<details>
84-
<summary><strong>Community Tools</strong></summary>
124+
<summary><strong>🛡️ Security & Privacy tools</strong></summary>
125+
126+
<br>
127+
128+
| Tool | Description |
129+
| :------------------ | :---------------------------------------------------------- |
130+
| **DefendNot** | Disable Windows Defender via Security Center API |
131+
| **RemoveWindowsAI** | Remove Copilot and Recall packages |
132+
| **privacy.sexy** | Comprehensive privacy hardening — standard or custom preset |
133+
134+
All tools run only when explicitly selected.
135+
136+
</details>
137+
138+
<details>
139+
<summary><strong>🎨 Desktop Customization</strong></summary>
140+
141+
<br>
142+
143+
Complete environment setup from one menu. Runs without admin.
144+
145+
**Desktop** — [GlazeWM](https://github.com/glzr-io/glazewm) tiling WM · [Zebar](https://github.com/glzr-io/zebar) status bar · [Flow Launcher](https://github.com/Flow-Launcher/Flow.Launcher) · [Windhawk](https://windhawk.net/) · [Rainmeter](https://www.rainmeter.net/)
146+
147+
**Terminal** — Windows Terminal config · Nerd Fonts · Oh My Posh / Starship · FastFetch · PowerShell profile
148+
149+
**Editors** — Config import for VSCode · Cursor · AIDE · Windsurf · VSCodium · Trae
150+
151+
**Themes** — Rectify11 · SpotX · Spicetify · Steam Millennium
152+
153+
</details>
154+
155+
<details>
156+
<summary><strong>💿 ISO Builder</strong></summary>
157+
158+
<br>
159+
160+
Create a bootable Windows 11 ISO with automation baked in:
161+
162+
- Embeds `autounattend.xml` answer file
163+
- Removes 25 bloatware apps (Cortana, Teams, Edge, News, OneDrive...)
164+
- Disables telemetry and Copilot
165+
- Bypasses TPM / SecureBoot / RAM checks
166+
- Launches Winrift on first login
167+
168+
<sub>→ <a href="docs/autounattend_guide.md">Autounattend Guide</a></sub>
169+
170+
</details>
171+
172+
<details>
173+
<summary><strong>📦 App Bundles</strong></summary>
174+
175+
<br>
176+
177+
Install curated app collections via [UniGetUI](https://github.com/marticliment/UniGetUI):
178+
179+
Development · Browsers · Utilities · Productivity · Creative & Media · Gaming · Communications
180+
181+
Uses winget, Chocolatey, and other package sources.
182+
183+
</details>
184+
185+
<details>
186+
<summary><strong>🌐 Community Tools</strong></summary>
85187

86188
<br>
87189

@@ -96,35 +198,67 @@ Other tools apply tweaks and hope for the best. Winrift measures 13 system metri
96198

97199
---
98200

99-
## Why Winrift?
201+
<a id="benchmark"></a>
100202

101-
📊 **Benchmark-First** — Captures 13 system metrics before and after every tweak. CPU load, RAM, DPC rate, disk latency — you see the real impact, not guesswork.
203+
## 📊 Benchmark
102204

103-
🔄 **Full Rollback** — Every registry change is backed up to JSON before it's applied. Combined with an automatic System Restore Point, nothing is permanent unless you want it to be.
205+
Other tools apply tweaks and hope for the best. Winrift measures 13 system metrics before and after — so you see exactly what changed.
104206

105-
🛡️ **Verified Execution** — All external scripts are checked against SHA256 hashes before running. No blind trust, no hidden downloads.
207+
> Typical results on clean Windows 11 24H2 (your numbers will vary):
106208
107-
🎨 **Beyond Tweaks** — Full desktop environment setup: tiling window managers, status bars, app launchers, terminal configs, editor themes, Spotify and Steam customization — all from one menu.
209+
| Metric | Before | After | Change |
210+
| :---------------- | --------: | -------: | -------: |
211+
| CPU idle load | 3.2% | 1.1% | **−66%** |
212+
| RAM usage | 2,800 MB | 2,100 MB | **−25%** |
213+
| Running processes | 142 | 98 | **−31%** |
214+
| Running services | 187 | 151 | **−19%** |
215+
| DPC rate | 48 /s | 22 /s | **−54%** |
216+
| Context switches | 12,400 /s | 8,600 /s | **−31%** |
108217

109-
💿 **ISO Builder** — Embed an answer file into a Windows 11 ISO to automate clean installs. Removes 25 bloatware apps, disables telemetry, and launches Winrift on first login.
218+
<sub>Full methodology and metric explanations: <a href="docs/tests.md">Testing & Benchmarks Guide</a></sub>
110219

111220
---
112221

113-
## Compatibility
222+
<a id="health-score"></a>
223+
224+
## 🩺 Health Score
225+
226+
Composite **0–100 rating** across 7 weighted categories with delta tracking — see how your system improves over time.
114227

115-
| Windows Version | Status |
116-
| :-------------: | :-----------: |
117-
| Windows 11 25H2 | Supported |
118-
| Windows 11 24H2 | Fully tested |
119-
| Windows 11 23H2 | Supported |
120-
| Windows 11 22H2 | Should work |
121-
| Windows 10 | Not supported |
228+
| Category | Weight | Checks |
229+
| :---------------- | :----: | :------------------------------------------- |
230+
| **Latency** | 20% | DPC rate, context switches, interrupts |
231+
| **Privacy** | 20% | Telemetry, diagnostics, Copilot, ad tracking |
232+
| **Memory** | 15% | RAM usage, committed ratio, page faults |
233+
| **Network** | 15% | Throttling, Nagle algorithm, TCP tuning |
234+
| **Process Bloat** | 10% | Running processes and services count |
235+
| **Startup** | 10% | Startup apps and scheduled tasks |
236+
| **Storage** | 10% | SSD/NVMe optimization, TRIM, prefetcher |
122237

123-
**Requirements:** PowerShell 5.1+ (included with Windows 11), Administrator privileges, Internet connection.
238+
> [!TIP]
239+
> Low-scoring categories get automatic recommendations. Run it before and after tweaks to track your improvement.
240+
241+
<sub>Scoring methodology → <a href="docs/health_score.md">Health Score Guide</a></sub>
242+
243+
---
244+
245+
<a id="compatibility"></a>
246+
247+
## ✅ Compatibility
248+
249+
| Windows Version | Status |
250+
| :--------------------- | :------------ |
251+
| Windows 11 25H2 | Fully tested |
252+
| Windows 11 24H2 / 22H2 | Supported |
253+
| Windows 10 | Not supported |
254+
255+
**Requirements:** PowerShell 5.1+ · Administrator · Internet connection
124256

125257
---
126258

127-
## Troubleshooting
259+
<a id="troubleshooting"></a>
260+
261+
## 🔧 Troubleshooting
128262

129263
| Problem | Solution |
130264
| :-------------------- | :----------------------------------------------------------- |
@@ -136,12 +270,16 @@ Other tools apply tweaks and hope for the best. Winrift measures 13 system metri
136270

137271
---
138272

139-
## Credits
273+
<a id="credits"></a>
274+
275+
## 🏆 Credits
140276

141277
Built on the work of [AlchemyTweaks/Verified-Tweaks](https://github.com/AlchemyTweaks/Verified-Tweaks), [ashish0kumar/windots](https://github.com/ashish0kumar/windots), [ChrisTitusTech/winutil](https://github.com/ChrisTitusTech/winutil), [flick9000/winscript](https://github.com/flick9000/winscript), [Greedeks/GTweak](https://github.com/Greedeks/GTweak), [Parcoil/Sparkle](https://github.com/Parcoil/Sparkle), [marticliment/UniGetUI](https://github.com/marticliment/UniGetUI).
142278

143279
<div align="center">
144280

145-
[MIT License](LICENSE) &bull; [Contributing](CONTRIBUTING.md) &bull; [Report a Bug](https://github.com/emylfy/winrift/issues)
281+
[MIT License](LICENSE) · [Contributing](CONTRIBUTING.md) · [Changelog](CHANGELOG.md) · [Report a Bug](https://github.com/emylfy/winrift/issues)
282+
283+
<sub>If Winrift improved your setup, consider leaving a ⭐</sub>
146284

147285
</div>

‎tests/Config.Tests.ps1‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@ Describe 'version.json' {
1616
{ $content | ConvertFrom-Json } | Should -Not -Throw
1717
}
1818

19-
It 'has a version property matching YY.M format' {
20-
$json.version | Should -Match '^\d+\.\d+$'
19+
It 'has a version property matching YY.M.patch format' {
20+
$json.version | Should -Match '^\d+\.\d+(\.\d+)?$'
2121
}
2222

2323
It 'has a channel property' {

0 commit comments

Comments
 (0)