diff --git a/README.md b/README.md index 393431b..8bf4999 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@
TweakHub wrench logo

TweakHub

-

A portable Windows 11 toolkit for power users who configure, rebuild and maintain PCs frequently.

+

A portable control center for Windows 11: add your own tweaks, scripts and favorites, carry it on a USB stick, and reach the specialist tools from one place.
For advanced users and technicians who configure, rebuild and maintain PCs. Free and open source (MIT).

Last commit GitHub stars @@ -19,13 +19,20 @@

Features · + How it compares · Screenshots · Download · Portable data · + FAQ · In depth · Build

-
+

+ Download the latest release + Install with WinGet +

+ TweakHub demo: registry tweaks, custom tweaks, the external tools catalog and the Connections check +

Real screen recording: registry tweaks, your own custom tweak, External Tools and Connections.

TweakHub Security overview with the security score ring
@@ -64,6 +71,17 @@ TweakHub is built to live on a USB drive. Extract it once, add your preferred to It runs as the current user and requests administrator privileges only when an operation requires them. Supported tweaks provide previews, backups and restoration. External tools and destructive maintenance scripts can make changes that TweakHub cannot undo. +## How it compares + +TweakHub does not try to replace [WinUtil](https://github.com/ChrisTitusTech/winutil), [Winaero Tweaker](https://winaero.com/winaero-tweaker/) or other tweak tools. It sits next to them. + +- **It is yours to extend.** Add your own Registry tweaks, PowerShell/CMD scripts, playbooks and tool cards next to the built-in ones, and keep a favorites section. You do not need to write a tool of your own. +- **It is portable.** Settings, scripts and rollback data stay beside `TweakHub.exe`, so you can carry the whole folder on a USB stick and configure many PCs. Nothing is stored in a cloud account. +- **It links the rest.** The External Tools catalog lists WinUtil and many single-purpose tools, including specialist ones for stability testing, overclocking, firmware and flashing (categories such as *Benchmarks & Stability* and *Firmware & Power*). Install TweakHub and reach the others from there. Cards open the tool's official page, and some also install it through WinGet. +- **Built-in tweaks are reversible.** Each has a preview, an automatic backup, verification and rollback. + +What it is not: a one-click optimizer, a tool for beginners (see the warning above), or a replacement for the dedicated tools it links. Windows 11 only. Releases may be unsigned. + ## Features @@ -283,6 +301,44 @@ The device-metadata and Windows Update driver policies affect different content: +## FAQ + +
+SmartScreen warns me when I run it. Is it safe? + +Releases may be unsigned, so Microsoft Defender SmartScreen can warn on first launch. Each release asset has a matching `.sha256` file: check it before running (`Get-FileHash .\TweakHub-Setup-.exe -Algorithm SHA256`). The source is public and releases are built by CI from tagged commits. +
+ +
+How do I undo a tweak? + +Built-in Registry tweaks keep a backup of the original values and each one can be restored; **Restore All Changes** restores everything TweakHub changed, and **Create Restore Point** takes a Windows restore point first. Do not delete the files in `Data` before restoring. External tools and destructive maintenance scripts (for example Tron) can make changes TweakHub cannot undo: back up your files first. +
+ +
+Can it affect games or anti-cheat? + +TweakHub does not touch game processes. It changes Windows settings, like any tweak tool, and we have not tested it against specific anti-cheat systems. It does not change Secure Boot or memory integrity: the Security page only opens the matching Windows settings. Preview each change and keep the **Tweak check** tab in mind: it flags popular tweaks that hurt stability. +
+ +
+Does it need administrator rights? + +It runs as the current user and asks for administrator privileges only for operations that need them. +
+ +
+Does it collect data? + +The source contains no analytics or telemetry code. The update check reads the GitHub releases API, and in-app updates are confirmed by you and verified with SHA-256. +
+ +
+Can I move it to another PC? + +Yes. Copy the complete portable folder (`TweakHub.exe`, `portable.flag` and `Data`), or export your profile under **Settings → Portable configuration**. Profiles do not include the programs under `Apps`. +
+ ## Hardware reports To help improve device detection and motherboard support, run the standalone [`Collect-TweakHub-Hardware.cmd`](Scripts/Collect-TweakHub-Hardware.cmd). It creates a local JSON report on the Desktop after consent, without changing settings or uploading anything. TweakHub and ThreadPilot do not need to be installed or running. See [collection instructions, privacy, limitations and Discord message](docs/hardware-reports.md) before sharing a report. diff --git a/docs/media/tweakhub-demo.gif b/docs/media/tweakhub-demo.gif new file mode 100644 index 0000000..35aab93 Binary files /dev/null and b/docs/media/tweakhub-demo.gif differ