jlammi/winutil
1
0
Fork 0
mirror of https://github.com/ChrisTitusTech/winutil synced 2026-02-04 06:50:09 +00:00
Code Issues Packages Projects Releases Wiki Activity

Docs, Winutil website update (#3947)

Browse Source 
* Updated winutil website

add git ignore to not upload unnecessarily file. i have also updated microwin docs and added a copyright info to the footer

* Update _index.md

* Update KnownIssues.md

* Update links

update all the links for github to the corresponding pages. i have kept the original links aswell but commented out

* update hugo workflow to use version 0.147.0

* Update en.yaml

* update hugo toml to get rid off powered by

* Update docs.yaml

* Update KnownIssues.md

* Update KnownIssues.md

* Update KnownIssues.md

* Update compatibility note for MicroWin and Ventoy

* removed quad 9 dns

* fixed all the incorrect code block in markdown file

* Replace hardcoded page lists with auto-discovery shortcode

Created a new shortcode at docs/layouts/shortcodes/autolinks.html. This enables auto-discovery when creating new Markdown files, streamlining the workflow for future documentation updates.

* updated os requirements
This commit is contained in:
Sean
2026-01-29 19:59:26 +00:00
committed by GitHub
parent 9013753d88
commit 99eb70d81b
35 changed files with 278 additions and 348 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
docs/content/userguide/getting-started.md
View File

@@ -11,7 +11,7 @@ Winutil is a powerful Windows utility that helps you optimize, customize, and ma
Before running Winutil, ensure your system meets these requirements:
- **Operating System**: Windows 10 (version 1809 or later) or Windows 11
- **Operating System**: Windows 10 (Latest Version) or Windows 11
- **PowerShell**: Version 5.1 or later (included by default in Windows 10/11)
- **Administrator Access**: Required for system-level changes
- **Internet Connection**: Required for downloading applications and updates
@@ -26,17 +26,20 @@ Winutil doesn't require traditional installation. It runs directly from PowerShe
There are several ways to open PowerShell with admin rights:
**Method 1: Start Menu (Recommended)**
1. Right-click on the Windows Start button
2. Select "Windows PowerShell (Admin)" on Windows 10
3. Or select "Terminal (Admin)" on Windows 11
**Method 2: Search Method**
1. Press the `Windows` key
2. Type "PowerShell" or "Terminal"
3. Press `Ctrl + Shift + Enter` to launch as administrator
4. Or right-click and select "Run as administrator"
**Method 3: Run Dialog**
1. Press `Windows + R`
2. Type `powershell`
3. Press `Ctrl + Shift + Enter`
@@ -46,11 +49,13 @@ There are several ways to open PowerShell with admin rights:
Once PowerShell is open with administrator privileges, run one of these commands:
**Stable Release (Recommended for most users)**
```powershell
irm "https://christitus.com/win" | iex
```
**Development Branch (For testing latest features)**
```powershell
irm "https://christitus.com/windev" | iex
```
@@ -61,6 +66,7 @@ irm "https://christitus.com/windev" | iex
### Step 3: Wait for Winutil to Load
The first time you run Winutil, it may take a few moments to:
- Download the latest version
- Initialize the interface
- Load all features and settings
@@ -80,6 +86,7 @@ On your first run, you may be prompted to configure WinGet (Windows Package Mana
Winutil opens with a clean, tabbed interface:
**Main Tabs**:
- **Install**: Browse and install applications
- **Tweaks**: Apply system optimizations and customizations
- **Config**: Access system tools and utilities
@@ -121,12 +128,14 @@ For a better Windows experience without risks:
### Installing Applications
**Single Application**:
1. Open **Install** tab
2. Search for the application name
3. Check the box next to it
4. Click "Install Selected"
**Multiple Applications**:
1. Check multiple application boxes
2. All checked apps will install in sequence
3. Progress is shown in the bottom panel
@@ -134,16 +143,19 @@ For a better Windows experience without risks:
### Applying Tweaks
**Essential Tweaks** (Safe for all users):
1. Go to **Tweaks** tab
2. Select from Essential Tweaks section
3. Click "Run Tweaks"
**Advanced Tweaks** (Use with caution):
1. Only modify if you understand the implications
2. Always create a restore point first
3. Review documentation for each tweak
**Undoing Tweaks**:
1. Select the same tweaks you applied
2. Click "Undo Selected Tweaks"
3. System will revert to previous state
@@ -183,6 +195,7 @@ Winutil offers several preset configurations:
## Safety Tips
✅ **DO**:
- Create restore points before major changes
- Read tweak descriptions before applying
- Start with Essential Tweaks
@@ -190,6 +203,7 @@ Winutil offers several preset configurations:
- Back up important data
❌ **DON'T**:
- Apply all tweaks at once without understanding them
- Skip creating restore points
- Use Advanced Tweaks without research
@@ -203,11 +217,13 @@ Winutil offers several preset configurations:
**If the download fails**:
1. Try the direct GitHub link:
```powershell
irm https://github.com/ChrisTitusTech/Winutil/releases/latest/download/Winutil.ps1 | iex
```
2. Force TLS 1.2 (for older Windows versions):
```powershell
[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12
irm "https://christitus.com/win" | iex
@@ -260,14 +276,14 @@ If you need assistance:
## Quick Reference Card
| Task | Location | Action |
|------|----------|--------|
| Install Apps | Install Tab | Check boxes → Install Selected |
| Apply Tweaks | Tweaks Tab | Select tweaks → Run Tweaks |
| Undo Tweaks | Tweaks Tab | Select tweaks → Undo Selected Tweaks |
| Create Restore Point | Tweaks Tab | Essential Tweaks section |
| Fix Network | Config Tab | Fixes → Reset Network |
| Change DNS | Tweaks Tab | DNS section |
| Open Control Panel | Config Tab | Legacy Windows Panels |
| Task | Location | Action |
| -------------------- | ----------- | ------------------------------------ |
| Install Apps | Install Tab | Check boxes → Install Selected |
| Apply Tweaks | Tweaks Tab | Select tweaks → Run Tweaks |
| Undo Tweaks | Tweaks Tab | Select tweaks → Undo Selected Tweaks |
| Create Restore Point | Tweaks Tab | Essential Tweaks section |
| Fix Network | Config Tab | Fixes → Reset Network |
| Change DNS | Tweaks Tab | DNS section |
| Open Control Panel | Config Tab | Legacy Windows Panels |
Happy optimizing! 🚀

27
docs/content/userguide/microwin/_index.md
View File

@@ -23,19 +23,19 @@ From this screen, you'll have to do one of the following:
{{< image src="images/microwin/microwin-downloader" >}}
> [!NOTE]
When downloading your ISO file, network conditions (such as speed and location) can affect the time you have to wait for the download to complete and the availability of such download.
> When downloading your ISO file, network conditions (such as speed and location) can affect the time you have to wait for the download to complete and the availability of such download.
### Compatibility
You may be wondering if your Windows image is compatible with the MicroWin process. Because of this, we present to you a compatibility list:
| Version | Compatible? |
|:--|:--|
| Windows 7 | ❌ Not supported |
| Windows 8 | ❌ Not supported |
| Windows 8.1 | ❌ Not supported |
| Windows 10 | ℹ️ Only the latest versions are supported, and you will not get the full experience |
| Windows 11 | 👍 Supported (21H2-24H2) |
| Version | Compatible? |
| :---------- | :----------------------------------------------------- |
| Windows 7 | ❌ Not supported |
| Windows 8 | ❌ Not supported |
| Windows 8.1 | ❌ Not supported |
| Windows 10 | ❌ Not supported, But may work on the latest versions. |
| Windows 11 | 👍 Supported (21H2-25H2) |
After getting information about your ISO file, you will see the following screen:
@@ -45,14 +45,14 @@ After getting information about your ISO file, you will see the following screen
To successfully use MicroWin with your Windows image, you need the following:
- **The latest versions of Windows 10, or Windows 11**
- **The latest versions of Windows 11**
- **Enough space**. We recommend having, at least, double the size of your ISO file. However, you may need more if you want to inject drivers
## Options
### Choosing your index
By default, MicroWin will target the Pro edition of Windows. The Pro edition is a good baseline for IT administrators **and** end-users, due to the inclusion of Group Policy, the ability to join domains, and more things that you can't find with the Home edition. For more information, check out [this comparison chart](https://en.wikipedia.org/wiki/Windows_10_editions#Comparison_chart).
By default, MicroWin will target the Pro edition of Windows. The Pro edition is a good baseline for IT administrators **and** end-users, due to the inclusion of Group Policy, the ability to join domains, and more things that you can't find with the Home edition. For more information, check out [this comparison chart](https://en.wikipedia.org/wiki/Windows_11_version_history).
Obviously, you should pick the edition of Windows for which you have a license. To change the edition to process, select the drop-down menu under "Choose Windows SKU" and select your edition.
@@ -67,7 +67,7 @@ If you want to use MicroWin on a real system, you may want to include the driver
- **Injecting VirtIO drivers:** if you plan on using the target Windows image with QEMU/Proxmox VE, or any UI that uses it (like `virt-manager` on Linux), you can automatically download the VirtIO driver ISO and put its contents into your ISO file
> [!NOTE]
Injecting VirtIO drivers is only supported on v25.01.11 and later
> Injecting VirtIO drivers is only supported on v25.01.11 and later
Of course, you can continue without setting up drivers. Simply leave the options blank and continue with the process.
@@ -145,6 +145,9 @@ If you have a Ventoy drive, you can copy your ISO file to it quickly and easily.
You can learn more about Ventoy drives [here](https://www.ventoy.net/en/index.html).
> [!NOTE]
> Newer versions of MicroWin images may have compatibility issues with ventoy.
### Setting up a custom user
If you want to set up a custom user, effectively creating a completely unattended installation, you can set up a user name and password:
@@ -152,7 +155,7 @@ If you want to set up a custom user, effectively creating a completely unattende
{{< image src="images/microwin/microwin-customuser" >}}
> [!NOTE]
To set up a custom user, you need to specify its name, which cannot surpass 20 characters. Otherwise, a user named "User" will be created. However, you don't need to set up a password. If you leave the password box blank, you can take advantage of auto-logons, but **do what you think it's best for your use case**.
> To set up a custom user, you need to specify its name, which cannot surpass 20 characters. Otherwise, a user named "User" will be created. However, you don't need to set up a password. If you leave the password box blank, you can take advantage of auto-logons, but **do what you think it's best for your use case**.
After configuring all your desired settings, click "Start the process" and specify the location of your ISO file.