Rework README.md (#4586)

* Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md
2026-06-04 14:17:27 +00:00 · 2026-06-03 20:56:58 +03:00
parent 893dca4055
commit 691224f465
1 changed files with 47 additions and 64 deletions
@@ -1,105 +1,88 @@
 # Chris Titus Tech's Windows Utility
 [![Version](https://img.shields.io/github/v/release/ChrisTitusTech/winutil?color=%230567ff&label=Latest%20Release&style=for-the-badge)](https://github.com/ChrisTitusTech/winutil/releases/latest)
-![GitHub Downloads (specific asset, all releases)](https://img.shields.io/github/downloads/ChrisTitusTech/winutil/winutil.ps1?label=Total%20Downloads&style=for-the-badge)
+![Downloads](https://img.shields.io/github/downloads/ChrisTitusTech/winutil/winutil.ps1?label=Total%20Downloads&style=for-the-badge)
-[![](https://dcbadge.limes.pink/api/server/https://discord.gg/RUbZUZyByQ?theme=default-inverted&style=for-the-badge)](https://discord.gg/RUbZUZyByQ)
+[![Discord](https://dcbadge.limes.pink/api/server/https://discord.gg/RUbZUZyByQ?theme=default-inverted&style=for-the-badge)](https://discord.gg/RUbZUZyByQ)
 [![Static Badge](https://img.shields.io/badge/Documentation-_?style=for-the-badge&logo=bookstack&color=grey)](https://winutil.christitus.com/)
-This utility is a compilation of Windows tasks I perform on each Windows system I use. It is meant to streamline *installs*, debloat with *tweaks*, troubleshoot with *config*, and fix Windows *updates*. I am extremely picky about any contributions to keep this project clean and efficient.
+A curated compilation of Windows system tasks streamline **installs**, debloat with **tweaks**, troubleshoot with **config**, and configure **Windows updates**. Run it fresh on every new Windows install.
-![screen-install](/docs/assets/images/Title-Screen.png)
+![Title Screen](/docs/assets/images/Title-Screen.png)
-## 💡 Usage
+---
-Winutil must be run in Admin mode because it performs system-wide tweaks. To achieve this, run PowerShell as an administrator. Here are a few ways to do it:
+## Quick Start
-1. **Start menu Method:**
+> **WinUtil must be run as Administrator** Because it performs system-wide changes.
   - Right-click on the start menu.
   - Choose "Windows PowerShell (Admin)" (for Windows 10) or "Terminal (Admin)" (for Windows 11).
-2. **Search and Launch Method:**
+Open PowerShell or Terminal as admin, then run:
   - Press the Windows key.
   - Type "PowerShell" or "Terminal" (for Windows 11).
   - Press `Ctrl + Shift + Enter` or Right-click and choose "Run as administrator" to launch it with administrator privileges.
 ### Launch Command
 #### Stable Branch (Recommended)
 **Stable Branch (recommended)**
 ```ps1
-irm "https://christitus.com/win" | iex
+irm https://christitus.com/win | iex
 ```
 #### Dev Branch
 ```ps1
 irm "https://christitus.com/windev" | iex
 ```
-### Automation
+**Development Branch**
 ```ps1
 irm https://christitus.com/windev | iex
 ```
-Winutil also supports predefined presets that apply common configurations automatically:
+### How to open an admin terminal
- `Standard`
+- **Start menu:** Right-click Start → *Windows PowerShell (Admin)* or *Terminal (Admin)*
- `Minimal`
+- **Search:** Press the `Windows key`, and type `PowerShell` or `Terminal`, then `Ctrl + Shift + Enter`
 - `Advanced`
-Example:
+---
 ## Automation / Presets
 Apply a predefined configuration without manual selection:
 ```powershell
-& ([ScriptBlock]::Create((irm "https://christitus.com/win"))) -Preset Standard
+& ([ScriptBlock]::Create((irm https://christitus.com/win))) -Preset Standard
 ```
 | Preset | Description |
 |--------|-------------|
 | `Standard` | Balanced defaults for most users |
 | `Minimal` | Minimal changes to suit every user |
 | `Advanced` | Deep tweaks for power users |
 To view exactly what each preset does, see:
 https://github.com/ChrisTitusTech/winutil/blob/main/config/preset.json
-If you have Issues, refer to [Known Issues](https://winutil.christitus.com/knownissues/) or [Create Issue](https://github.com/ChrisTitusTech/winutil/issues)
+---
-## 🎓 Documentation
+## Build & Develop
-### [WinUtil Official Documentation](https://winutil.christitus.com/)
+See https://github.com/ChrisTitusTech/winutil/blob/main/.github/CONTRIBUTING.md
-### [YouTube Tutorial](https://www.youtube.com/watch?v=6UQZ5oQg8XA)
+---
-### [ChrisTitus.com Article](https://christitus.com/windows-tool/)
+## Resources
-## 🛠️ Build & Develop
+- [Official Documentation](https://winutil.christitus.com/)
 - [YouTube Tutorial](https://www.youtube.com/watch?v=6UQZ5oQg8XA)
 - [ChrisTitus.com Article](https://christitus.com/windows-tool/)
 - [Known Issues](https://winutil.christitus.com/knownissues/)
 - [Report an Issue](https://github.com/ChrisTitusTech/winutil/issues)
-> [!NOTE]
+---
 > Winutil is a relatively large script, so it's split into multiple files which're combined into a single `.ps1` file using a custom compiler. This makes maintaining the project a lot easier.
-Get a copy of the source code. This can be done using GitHub UI (**Code** > **Download ZIP**), or by cloning (downloading) the repo using git.
+## Support
-If git is installed, run the following commands under a PowerShell window to clone and move into the project's directory:
+- Leave a ⭐ to show support!
 ```ps1
 git clone --depth 1 "https://github.com/ChrisTitusTech/winutil.git"
 cd winutil
 ```
 To build the project, run the Compile Script under a PowerShell window (admin permissions IS NOT required):
 ```ps1
 .\Compile.ps1
 ```
 You'll see a new file named `winutil.ps1`, which was created by `Compile.ps1` script. Now you can run it as admin, and a new window will pop up. Enjoy your own compiled version of WinUtil :)
 > [!TIP]
 > For more info on using WinUtil and how to develop for it, please consider reading [the Contribution Guidelines](https://winutil.christitus.com/contributing/). If you don't know where to start, or have questions, you can ask over on our [Discord Community Server](https://discord.gg/RUbZUZyByQ), and active project members will answer when they can.
 ## 💖 Support
 - To morally and mentally support the project, make sure to leave a ⭐️!
 - EXE Wrapper for $10 @ https://www.cttstore.com/windows-toolbox
-## 💖 Sponsors
+## Sponsors
 These are the sponsors that help keep this project alive with monthly contributions.
 <!-- sponsors --><a href="https://github.com/dwelfusius"><img src="https:&#x2F;&#x2F;github.com&#x2F;dwelfusius.png" width="60px" alt="User avatar: " /></a><a href="https://github.com/mews-se"><img src="https:&#x2F;&#x2F;github.com&#x2F;mews-se.png" width="60px" alt="User avatar: Martin Stockzell" /></a><a href="https://github.com/jdiegmueller"><img src="https:&#x2F;&#x2F;github.com&#x2F;jdiegmueller.png" width="60px" alt="User avatar: Jason A. Diegmueller" /></a><a href="https://github.com/robertsandrock"><img src="https:&#x2F;&#x2F;github.com&#x2F;robertsandrock.png" width="60px" alt="User avatar: RMS" /></a><a href="https://github.com/paulsheets"><img src="https:&#x2F;&#x2F;github.com&#x2F;paulsheets.png" width="60px" alt="User avatar: Paul" /></a><a href="https://github.com/djones369"><img src="https:&#x2F;&#x2F;github.com&#x2F;djones369.png" width="60px" alt="User avatar: Dave J  (WhamGeek)" /></a><a href="https://github.com/anthonymendez"><img src="https:&#x2F;&#x2F;github.com&#x2F;anthonymendez.png" width="60px" alt="User avatar: Anthony Mendez" /></a><a href="https://github.com/FatBastard0"><img src="https:&#x2F;&#x2F;github.com&#x2F;FatBastard0.png" width="60px" alt="User avatar: " /></a><a href="https://github.com/DursleyGuy"><img src="https:&#x2F;&#x2F;github.com&#x2F;DursleyGuy.png" width="60px" alt="User avatar: DursleyGuy" /></a><a href="https://github.com/DwayneTheRockLobster1"><img src="https:&#x2F;&#x2F;github.com&#x2F;DwayneTheRockLobster1.png" width="60px" alt="User avatar: " /></a><a href="https://github.com/KieraKujisawa"><img src="https:&#x2F;&#x2F;github.com&#x2F;KieraKujisawa.png" width="60px" alt="User avatar: Kiera Meredith" /></a><a href="https://github.com/andrewpayne68"><img src="https:&#x2F;&#x2F;github.com&#x2F;andrewpayne68.png" width="60px" alt="User avatar: Andrew P" /></a><!-- sponsors -->
-## 🏅 Thanks to all Contributors
+---
-Thanks a lot for spending your time helping Winutil grow. Thanks a lot! Keep rocking 🍻.
+
 ## Contributors
 [![Contributors](https://contrib.rocks/image?repo=ChrisTitusTech/winutil)](https://github.com/ChrisTitusTech/winutil/graphs/contributors)
-## 📊 GitHub Stats
+Thanks to everyone who has contributed time and effort to this project. Keep rocking 🍻
 ![Alt](https://repobeats.axiom.co/api/embed/aad37eec9114c507f109d34ff8d38a59adc9503f.svg "Repobeats analytics image")