[DOCS] Update (#2427)
* index, known issues & contribute * revamp some existing stuff * rework on existing stuff * rework existing stuff + add new stuff * remove unused folder & imgs * undo winutil * replace faulty formatted line with tip Co-authored-by: Mr.k <mineshtine28546271@gmail.com> * hotfix for tip * fix grammer issues * fix grammer issues Corrected various grammatical errors in the documentation files. This includes fixing typos, adjusting punctuation, and improving sentence structure for better readability. --------- Co-authored-by: Mr.k <mineshtine28546271@gmail.com>
@ -6,7 +6,7 @@
|
|||||||
|
|
||||||
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.
|
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.
|
||||||
|
|
||||||
![screen-install](./docs/assets/screen-install.png)
|
![screen-install](./docs/assets/Title-Screen.png)
|
||||||
|
|
||||||
## 💡 Usage
|
## 💡 Usage
|
||||||
|
|
||||||
|
@ -1,5 +1,3 @@
|
|||||||
## Known Issues and Fixes
|
|
||||||
|
|
||||||
### Launch Issues:
|
### Launch Issues:
|
||||||
|
|
||||||
- Windows Security (formerly Defender) and other anti-virus software are known to block the script. The script gets flagged due to the fact that it requires administrator privileges & makes drastic system changes.
|
- Windows Security (formerly Defender) and other anti-virus software are known to block the script. The script gets flagged due to the fact that it requires administrator privileges & makes drastic system changes.
|
||||||
@ -14,10 +12,14 @@
|
|||||||
- If you are unable to resolve `christitus.com/win` and are getting errors launching the tool, it might be due to India blocking GitHub's content domain and preventing downloads.
|
- If you are unable to resolve `christitus.com/win` and are getting errors launching the tool, it might be due to India blocking GitHub's content domain and preventing downloads.
|
||||||
- Source: <https://timesofindia.indiatimes.com/gadgets-news/github-content-domain-blocked-for-these-indian-users-reports/articleshow/96687992.cms>
|
- Source: <https://timesofindia.indiatimes.com/gadgets-news/github-content-domain-blocked-for-these-indian-users-reports/articleshow/96687992.cms>
|
||||||
|
|
||||||
If you are still having issues try using a **VPN**, or changing your **DNS provider** to:
|
If you are still having issues try using a **VPN**, or changing your **DNS provider** to one of following two providers:
|
||||||
|
|
||||||
|
| Provider | Primary DNS | Secondary DNS |
|
||||||
|
|:------------:|:------------:|:-------------:|
|
||||||
|
| Cloudflare | `1.1.1.1` | `1.0.0.1` |
|
||||||
|
| Google | `8.8.8.8` | `8.8.4.4` |
|
||||||
|
|
||||||
|
|
||||||
| `1.1.1.1` | `1.0.0.1` | or | `8.8.8.8` | `8.8.4.4` |
|
|
||||||
|---------|---------|-----|---------|---------|
|
|
||||||
|
|
||||||
- Script doesn't run/PowerShell crashes:
|
- Script doesn't run/PowerShell crashes:
|
||||||
1. Press Windows Key+X and select 'PowerShell (Admin)' (Windows 10) or 'Windows Terminal (Admin)' (Windows 11)
|
1. Press Windows Key+X and select 'PowerShell (Admin)' (Windows 10) or 'Windows Terminal (Admin)' (Windows 11)
|
||||||
@ -53,7 +55,7 @@ Get-Service -Name "XboxGipSvc" | Set-Service -StartupType Automatic
|
|||||||
- Explorer no longer launches: Go to Control Panel, File Explorer Options, Change the 'Open File Explorer to' option to 'This PC'.
|
- Explorer no longer launches: Go to Control Panel, File Explorer Options, Change the 'Open File Explorer to' option to 'This PC'.
|
||||||
|
|
||||||
### Battery drains too fast.
|
### Battery drains too fast.
|
||||||
When your battery on the laptop drains too fast, please perform these steps and report the results back to the Winutil community.
|
* When your battery on the laptop drains too fast, please perform these steps and report the results back to the Winutil community.
|
||||||
|
|
||||||
1. **Check Battery Health:**
|
1. **Check Battery Health:**
|
||||||
- Open a Command Prompt as an administrator.
|
- Open a Command Prompt as an administrator.
|
||||||
@ -134,13 +136,13 @@ When your battery on the laptop drains too fast, please perform these steps and
|
|||||||
- Check settings/preferences of individual applications for power-related options.
|
- Check settings/preferences of individual applications for power-related options.
|
||||||
- Uninstall unnecessary or problematic software.
|
- Uninstall unnecessary or problematic software.
|
||||||
|
|
||||||
By following these detailed instructions, you should be able to thoroughly diagnose and address battery drain issues on your Windows laptop. Adjust settings as needed to optimize power management and improve battery life.
|
* By following these detailed instructions, you should be able to thoroughly diagnose and address battery drain issues on your Windows laptop. Adjust settings as needed to optimize power management and improve battery life.
|
||||||
|
|
||||||
### Troubleshoot errors during Microwin usage
|
### Troubleshoot errors during Microwin usage
|
||||||
|
|
||||||
#### Error `0x80041031`
|
#### Error `0x80041031`
|
||||||
|
|
||||||
This error code typically indicates an issue related to Windows Management Instrumentation (WMI). Here are a few steps you can try to resolve the issue:
|
* This error code typically indicates an issue related to Windows Management Instrumentation (WMI). Here are a few steps you can try to resolve the issue:
|
||||||
|
|
||||||
1. **Reboot Your Computer:**
|
1. **Reboot Your Computer:**
|
||||||
Sometimes, a simple reboot can resolve temporary issues. Restart your computer and try mounting the ISO again.
|
Sometimes, a simple reboot can resolve temporary issues. Restart your computer and try mounting the ISO again.
|
||||||
@ -174,4 +176,4 @@ This error code typically indicates an issue related to Windows Management Instr
|
|||||||
7. **ISO File Integrity:**
|
7. **ISO File Integrity:**
|
||||||
Ensure that the ISO file you are trying to mount is uncorrupted. Try mounting a different ISO file to see if the issue persists.
|
Ensure that the ISO file you are trying to mount is uncorrupted. Try mounting a different ISO file to see if the issue persists.
|
||||||
|
|
||||||
If the problem persists after trying these steps, additional troubleshooting is required. Consider seeking assistance from Microsoft support or community forums for more specific guidance based on your system configuration and the software you use to mount the ISO.
|
* If the problem persists after trying these steps, additional troubleshooting is required. Consider seeking assistance from Microsoft support or community forums for more specific guidance based on your system configuration and the software you use to mount the ISO.
|
BIN
docs/assets/Commit-GHD.png
Normal file
After Width: | Height: | Size: 194 KiB |
Before Width: | Height: | Size: 42 KiB |
BIN
docs/assets/Compile.png
Normal file
After Width: | Height: | Size: 17 KiB |
Before Width: | Height: | Size: 12 KiB After Width: | Height: | Size: 12 KiB |
BIN
docs/assets/Discard-GHD.png
Normal file
After Width: | Height: | Size: 6.8 KiB |
BIN
docs/assets/Fork-Button-Dark.png
Normal file
After Width: | Height: | Size: 14 KiB |
BIN
docs/assets/Fork-Button-Light.png
Normal file
After Width: | Height: | Size: 22 KiB |
Before Width: | Height: | Size: 19 KiB |
BIN
docs/assets/Get-Installed-Dark.png
Normal file
After Width: | Height: | Size: 36 KiB |
BIN
docs/assets/Get-Installed-Light.png
Normal file
After Width: | Height: | Size: 27 KiB |
Before Width: | Height: | Size: 91 KiB |
BIN
docs/assets/Install-Tab-Dark.png
Normal file
After Width: | Height: | Size: 152 KiB |
BIN
docs/assets/Install-Tab-Light.png
Normal file
After Width: | Height: | Size: 137 KiB |
BIN
docs/assets/Microwin-Dark.png
Normal file
After Width: | Height: | Size: 108 KiB |
BIN
docs/assets/Microwin-Light.png
Normal file
After Width: | Height: | Size: 79 KiB |
Before Width: | Height: | Size: 138 KiB |
Before Width: | Height: | Size: 303 KiB |
Before Width: | Height: | Size: 132 KiB |
BIN
docs/assets/Push-Commit.png
Normal file
After Width: | Height: | Size: 77 KiB |
BIN
docs/assets/Screen.png
Normal file
After Width: | Height: | Size: 264 KiB |
BIN
docs/assets/Settings-Export-Dark.png
Normal file
After Width: | Height: | Size: 40 KiB |
BIN
docs/assets/Settings-Export-Light.png
Normal file
After Width: | Height: | Size: 28 KiB |
Before Width: | Height: | Size: 99 KiB |
Before Width: | Height: | Size: 339 KiB After Width: | Height: | Size: 339 KiB |
BIN
docs/assets/Tweaks-Tab-Dark.png
Normal file
After Width: | Height: | Size: 150 KiB |
BIN
docs/assets/Tweaks-Tab-Light.png
Normal file
After Width: | Height: | Size: 99 KiB |
Before Width: | Height: | Size: 101 KiB |
@ -1,57 +1,105 @@
|
|||||||
# How to Contribute?
|
# How to Contribute?
|
||||||
|
|
||||||
|
## Testing
|
||||||
|
|
||||||
|
* Test the latest changes to WinUtil by running the pre-release and reporting issues you are encountering to help us continually improve WinUtil!
|
||||||
|
|
||||||
|
#### **Run the latest pre-release**
|
||||||
|
```ps1
|
||||||
|
irm christitus.com/windev | iex
|
||||||
|
```
|
||||||
|
|
||||||
|
!!! bug "Keep in mind"
|
||||||
|
|
||||||
|
This is a pre-release and should be treated as such. It exists for developers to test the utility and report or fix bugs before they get added to the stable release. Don't use it in production!
|
||||||
|
|
||||||
## Issues
|
## Issues
|
||||||
|
|
||||||
* If you encounter any challenges or problems with the script, I kindly request that you submit them via the "Issues" tab on the GitHub repository. By filling out the provided template, you can provide specific details about the issue, allowing me (and others in the community) to promptly address any bugs, or consider feature requests.
|
* If you encounter any challenges or problems with the script, I kindly request that you submit them via the "Issues" tab on the GitHub repository. By filling out the provided template, you can provide specific details about the issue, allowing me (and others in the community) to promptly address any bugs or consider feature requests.
|
||||||
|
|
||||||
## Contribute Code
|
## Contribute Code
|
||||||
|
|
||||||
* Pull Requests are now handled directly on the **MAIN branch**. This was done since we can now select specific releases to launch via releases in GitHub.
|
* Pull requests are now handled directly on the **MAIN branch**. This was done since we can now select specific releases to launch via releases in GitHub.
|
||||||
|
|
||||||
* If you're doing code changes, then you can submit a PR to `main` branch, but I am very selective about these.
|
* If you're doing code changes, then you can submit a PR to `main` branch, but I am very selective about these.
|
||||||
|
|
||||||
> [!WARNING]
|
!!! warning "Important"
|
||||||
> Do not use a code formatter, massive amounts of line changes, and make multiple feature changes.
|
|
||||||
> EACH FEATURE CHANGE SHOULD BE IT'S OWN Pull Request!
|
|
||||||
|
|
||||||
* When creating pull requests, it is essential to thoroughly document all changes made. This includes, but not limited to, documenting any additions made to the `tweaks` section and corresponding `undo tweak`, so users are able to remove the newly added tweaks if necessary, and comprehensive documentation is required for all code changes, document your changes and briefly explain why you made your changes in your Pull Request Description. Failure to adhere to this format may result in denial of the pull request. Additionally, Any code lacking sufficient documentation may also be denied.
|
Do not use a code formatter, make massive amounts of line changes, or make multiple feature changes. EACH FEATURE CHANGE SHOULD BE IT'S OWN PULL REQUEST!
|
||||||
|
|
||||||
|
* When creating pull requests, it is essential to thoroughly document all changes made. This includes, but is not limited to, documenting any additions made to the `tweaks` section and corresponding `undo tweak`, so users are able to remove the newly added tweaks if necessary, and comprehensive documentation is required for all code changes. Document your changes and briefly explain why you made your changes in your Pull Request Description. Failure to adhere to this format may result in the denial of the pull request. Additionally, any code lacking sufficient documentation may also be denied.
|
||||||
|
|
||||||
* By following these guidelines, we can maintain a high standard of quality and ensure that the codebase remains organized and well-documented.
|
* By following these guidelines, we can maintain a high standard of quality and ensure that the codebase remains organized and well-documented.
|
||||||
|
|
||||||
> [!NOTE]
|
!!! note
|
||||||
> When creating a function, please include "WPF" or "WinUtil" in the file name so it can be loaded into the runspace.
|
|
||||||
|
When creating a function, please include "WPF" or "WinUtil" in the file name so it can be loaded into the runspace.
|
||||||
|
|
||||||
## Walk through
|
## Walk through
|
||||||
|
|
||||||
|
* This is a guide for beginners. If you are still having issues, look at the following official GitHub documentation:
|
||||||
|
* [Commit through WEB](https://docs.github.com/en/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/about-commits)
|
||||||
|
* [Commit through GitHub Desktop](https://docs.github.com/en/desktop/making-changes-in-a-branch/committing-and-reviewing-changes-to-your-project-in-github-desktop#about-commits)
|
||||||
|
* [Create a Pull Request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request)
|
||||||
|
|
||||||
|
|
||||||
|
### Overview
|
||||||
|
|
||||||
|
``` mermaid
|
||||||
|
graph LR
|
||||||
|
A[Fork Project] --> B[Clone Repository];
|
||||||
|
B --> C[Create New Branch];
|
||||||
|
C --> D[Make Changes];
|
||||||
|
D --> G[Test Changes];
|
||||||
|
G --> H{Tests Passed?};
|
||||||
|
H -->|Yes| E[Commit Changes];
|
||||||
|
E --> F[Push Branch];
|
||||||
|
H -->|No| J[Fix Issues];
|
||||||
|
F --> K[Create Pull Request];
|
||||||
|
K --> L[Fill out PR template];
|
||||||
|
J --> G;
|
||||||
|
```
|
||||||
|
!!! info
|
||||||
|
|
||||||
|
This is a diagram to guide you through the process. It may vary depending on the type of change you're making.
|
||||||
|
|
||||||
### Fork the Repo
|
### Fork the Repo
|
||||||
* Fork the WinUtil Repository [here](https://github.com/ChrisTitusTech/winutil) to create a copy that will be available in your Repository-list.
|
* Fork the WinUtil Repository [here](https://github.com/ChrisTitusTech/winutil) to create a copy that will be available in your repository list.
|
||||||
![Fork](assets/ForkButton.png)
|
![Fork Image](assets/Fork-Button-Dark.png#only-dark)
|
||||||
|
![FOrk Image](assets/Fork-Button-Light.png#only-light)
|
||||||
|
|
||||||
### Clone the Fork
|
### Clone the Fork
|
||||||
* While you can make your changes directly through the Web, we recommend cloning the repo to your device to test your fork easily.
|
!!! tip
|
||||||
* Using the application GitHub Desktop (available in WinUtil) you can easily manage your repos locally. You can do it using other tools like git-cli (available in WinUtil), we recommend GitHub Desktop for ease of use.
|
|
||||||
* Install GitHub Desktop if not already installed
|
|
||||||
* Log in using the same GitHub account u used to fork WinUtil
|
|
||||||
* Choose the fork under "Your Repositories" and press "clone {repo name}"
|
|
||||||
* Create a new Branch and name it something relatable to your changes,
|
|
||||||
|
|
||||||
* Now you can modify WinUtil to your liking using your prefered text editor.
|
While you can make your changes directly through the Web, we recommend cloning the repo to your device using the application GitHub Desktop (available in WinUtil) to test your fork easily.
|
||||||
|
|
||||||
|
* Install GitHub Desktop if it is not already installed.
|
||||||
|
* Log in using the same GitHub account you used to fork WinUtil.
|
||||||
|
* Choose the fork under "Your Repositories" and press "clone {repo name}"
|
||||||
|
* Create a new branch and name it something relatable to your changes.
|
||||||
|
|
||||||
|
* Now you can modify WinUtil to your liking using your preferred text editor.
|
||||||
|
|
||||||
|
|
||||||
### Testing your changes
|
### Testing your changes
|
||||||
* To test to see if your changes work as intended run following commands in a powershell teminal:
|
* To test to see if your changes work as intended, run the following commands in a powershell terminal:
|
||||||
|
|
||||||
* Change the directory where you are running the commands to the forked project.
|
* Change the directory where you are running the commands to the forked project.
|
||||||
* `cd {path to the folder with the compile.ps1}`
|
* `cd {path to the folder with the compile.ps1}`
|
||||||
* Run following command to compile and run Winutil
|
* Run the following command to compile and run WinUtil:
|
||||||
* `.\Compile.ps1 -run`
|
* `.\Compile.ps1 -run`
|
||||||
* After seeing that your changes work properly feel free to commit the changes to the repository and make a PR, for help on that follow the documentation below.
|
* ![Compile](assets/Compile.png)
|
||||||
|
* After seeing that your changes work properly, feel free to commit the changes to the repository and make a PR. For help on that, follow the documentation below.
|
||||||
|
|
||||||
### Commiting the changes
|
### Committing the changes
|
||||||
* Commit your changes once you are fine with the result
|
* Before committing your changes, please discard changes made to the `winutil.ps1` file, like the following:
|
||||||
* Push the changes to "upload" them to your fork on github.com.
|
- ![Push Commit Image](assets/Discard-GHD.png)
|
||||||
|
* Now, commit your changes once you are happy with the result.
|
||||||
|
![Commit Image](assets/Commit-GHD.png)
|
||||||
|
* Push the changes to upload them to your fork on github.com.
|
||||||
|
![Push Commit Image](assets/Push-Commit.png)
|
||||||
|
|
||||||
### Making a PR
|
### Making a PR
|
||||||
* To make a PR on your repo under a new branch linking to the main branch a button will show and say Preview and Create pull request. Click that button and fill in all information that is provided on the template. Once all the information is filled in correctly check your PR to make sure there is not a WinUtil.ps1 file attached to the PR. Once everything is good make the PR and wait for Chris (The Maintainer) to accept or deny your PR. Once it is accepted in by Chris you will be able to see your changes in the /windev build.
|
* To make a PR on your repo under a new branch linking to the main branch, a button will show and say Preview and Create pull request. Click that button and fill in all the information that is provided on the template. Once all the information is filled in correctly, check your PR to make sure there is not a WinUtil.ps1 file attached to the PR. Once everything is good, make the PR and wait for Chris (the maintainer) to accept or deny your PR. Once it is accepted by Chris, you will be able to see your changes in the "/windev" build.
|
||||||
* If you do not see your feature in the main /win build that is fine. As all new changes go into the /windev build to make sure everything is working ok before going fully public.
|
* If you do not see your feature in the main "/win" build, that is fine. All new changes go into the /windev build to make sure everything is working OK before going fully public.
|
||||||
* Congrats you just submitted your first PR. Thank you so much for contributing to WinUtil.
|
* Congratulations! You just submitted your first PR. Thank you so much for contributing to WinUtil.
|
@ -1,4 +1,4 @@
|
|||||||
# FAQ's
|
# FAQ's
|
||||||
|
|
||||||
## How do I uninstall WinUtil?
|
## How do I uninstall WinUtil?
|
||||||
* You do not have to uninstall WinUtil. As it is a script you run from Powershell it only loads into your RAM. This means as soon as you close WinUtil it will be deleted off your system.
|
* You do not have to uninstall WinUtil. As it is a script you run from PowerShell, it only loads into your RAM. This means that as soon as you close WinUtil, it will be deleted from your system.
|
@ -1,12 +1,20 @@
|
|||||||
# Welcome to Chris Titus WinUtil Official Documentation!
|
# Welcome to the WinUtil Documentation!
|
||||||
|
|
||||||
[![](https://dcbadge.limes.pink/api/server/https://discord.gg/RUbZUZyByQ)](https://discord.gg/RUbZUZyByQ)
|
[![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)
|
||||||
|
|
||||||
## Running
|
[![Discord Community Server](https://dcbadge.limes.pink/api/server/https://discord.gg/RUbZUZyByQ)](https://discord.gg/RUbZUZyByQ)
|
||||||
|
|
||||||
There are 4 ways to run WinUtil. The 4 ways goes as follows:
|
Welcome to the official documentation for WinUtil, your go-to utility for optimizing and managing your Windows environment. Whether you’re an IT professional, power user, or regular user, WinUtil provides a comprehensive set of tools to enhance your Windows experience.
|
||||||
|
|
||||||
* `irm christitus.com/win | iex` - Runs WinUtil from ChrisTitus's website using the latest Full Releases.
|
## Running the latest release of WinUtil
|
||||||
* `irm https://github.com/ChrisTitusTech/winutil/releases/latest/download/winutil.ps1 | iex` - Runs WinUtil from github using the latest Full Release.
|
|
||||||
* `irm christitus.com/windev | iex` - Runs WinUtil from ChrisTitus website using the latest Pre-Release.
|
* You will first need to start a Powershell terminal **as Admin**.
|
||||||
* `irm https://github.com/ChrisTitusTech/winutil/releases/latest/download/windev.ps1 | iex` - Runs WinUtil from github using the latest Pre-Release.
|
* Now you can run the following command:
|
||||||
|
```ps1
|
||||||
|
irm christitus.com/win | iex
|
||||||
|
```
|
||||||
|
|
||||||
|
!!! info
|
||||||
|
|
||||||
|
WinUtil is updated weekly as of the time of writing. Consequently, features and functionalities may evolve, and the documentation may not always reflect the most current images or information.
|
@ -1,72 +1,121 @@
|
|||||||
# User Guide
|
# Walkthrough
|
||||||
|
|
||||||
## Overview
|
## Install
|
||||||
* short one
|
---
|
||||||
|
|
||||||
|
=== "Installation & Updates"
|
||||||
|
|
||||||
|
* Choose the programs you want to install or upgrade.
|
||||||
|
* For programs not currently installed, this action will install them.
|
||||||
|
* For programs already installed, this action will update them to the latest version.
|
||||||
|
* Click the `Install/Upgrade Selected` button to start the installation or upgrade process.
|
||||||
|
|
||||||
|
=== "Upgrade All"
|
||||||
|
|
||||||
|
* Simply press the `Upgrade All` button.
|
||||||
|
* This will upgrade all applicable programs that are installed without the need for individual selection.
|
||||||
|
|
||||||
|
=== "Uninstall"
|
||||||
|
|
||||||
|
* Select the programs you wish to uninstall.
|
||||||
|
* Click the `Uninstall Selected` button to remove the selected programs.
|
||||||
|
|
||||||
|
=== "Get Installed"
|
||||||
|
|
||||||
|
* Click the `Get Installed` button.
|
||||||
|
* This will scan for and select all installed programs in WinUtil that WinGet supports.
|
||||||
|
|
||||||
|
=== "Clear Selection"
|
||||||
|
|
||||||
|
* Click the `Clear Selection` button.
|
||||||
|
* This will unselect all checked programs.
|
||||||
|
|
||||||
|
![Install Image](assets/Install-Tab-Dark.png#only-dark)
|
||||||
|
![Install Image](assets/Install-Tab-Light.png#only-light)
|
||||||
|
!!! tip
|
||||||
|
|
||||||
|
If you have trouble finding an application, press `ctrl + f` and search the name of it. Applications will filter depending on your input.
|
||||||
|
|
||||||
|
## Tweaks
|
||||||
|
---
|
||||||
|
|
||||||
|
![Tweaks Image](assets/Tweaks-Tab-Dark.png#only-dark)
|
||||||
|
![Tweaks Image](assets/Tweaks-Tab-Light.png#only-light)
|
||||||
|
|
||||||
|
### Run Tweaks
|
||||||
|
* **Open Tweaks Tab**: Navigate to the 'Tweaks' tab in the application.
|
||||||
|
* **Select Tweaks**: Choose the tweaks you want to apply. You can use the presets available at the top for convenience.
|
||||||
|
* **Run Tweaks**: After selecting the desired tweaks, click the 'Run Tweaks' button at the bottom of the screen.
|
||||||
|
|
||||||
|
### Undo Tweaks
|
||||||
|
* **Open Tweaks Tab**: Go to the 'Tweaks' tab located next to 'Install'.
|
||||||
|
* **Select Tweaks to Remove**: Choose the tweaks you want to disable or remove.
|
||||||
|
* **Undo Tweaks**: Click the 'Undo Selected Tweaks' button at the bottom of the screen to apply the changes.
|
||||||
|
|
||||||
|
### Essential Tweaks
|
||||||
|
Essential Tweaks are modifications and optimizations that are generally safe for most users to implement. These tweaks are designed to enhance system performance, improve privacy, and reduce unnecessary system activities. They are considered low-risk and are recommended for users who want to ensure their system runs smoothly and efficiently without delving too deeply into complex configurations. The goal of Essential Tweaks is to provide noticeable improvements with minimal risk, making them suitable for a wide range of users, including those who may not have advanced technical knowledge.
|
||||||
|
|
||||||
|
### Advanced Tweaks - CAUTION
|
||||||
|
Advanced Tweaks are intended for experienced users who have a solid understanding of their system and the potential implications of making deep-level changes. These tweaks involve more significant alterations to the operating system and can provide substantial customization. However, they also carry a higher risk of causing system instability or unintended side effects if not implemented correctly. Users who choose to apply Advanced Tweaks should proceed with caution, ensuring they have adequate knowledge and backups in place to recover if something goes wrong. These tweaks are not recommended for novice users or those unfamiliar with the inner workings of their operating system.
|
||||||
|
|
||||||
|
### O&O Shutup
|
||||||
|
|
||||||
|
[O&O ShutUp10++](https://www.oo-software.com/en/shutup10) can be launched from WinUtil with only one button click. It is a free privacy tool for Windows that lets users easily manage their privacy settings. It disables telemetry, controls updates, and manages app permissions to enhance security and privacy. The tool offers recommended settings for optimal privacy with just a few clicks.
|
||||||
|
|
||||||
|
<iframe width="640" height="360" src="https://www.youtube.com/embed/3HvNr8eMcv0" title="O&O ShutUp10++: For Windows 10 & 11, with Dark Mode" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe>
|
||||||
|
|
||||||
|
|
||||||
## Walkthrough
|
### DNS
|
||||||
|
|
||||||
### Program
|
The utility provides a convenient DNS selection feature, allowing users to choose between various DNS providers for both IPv4 and IPv6. This enables users to optimize their internet connection for speed, security, and privacy according to their specific needs. Here are the available options:
|
||||||
|
|
||||||
#### Installation & Updates
|
* **Default**: Uses the default DNS settings configured by your ISP or network.
|
||||||
* To install programs select the programs you wish to install or update like the picture below.
|
* **DHCP**: Automatically acquires DNS settings from the DHCP server.
|
||||||
![Program Install](assets/ProgramInstall.png)
|
* [**Google**](https://developers.google.com/speed/public-dns?hl=de): A reliable and fast DNS service provided by Google.
|
||||||
* Once you have selected the programs you wish to install click the select Install/Upgrade Selected button as seen below.
|
* [**Cloudflare**](https://developers.cloudflare.com/1.1.1.1/): Known for speed and privacy, Cloudflare DNS is a popular choice for enhancing internet performance.
|
||||||
![Program Install Button](assets/ProgramInstallButton.png)
|
* [**Cloudflare_Malware**](https://developers.cloudflare.com/1.1.1.1/setup/#:~:text=Use%20the%20following%20DNS%20resolvers%20to%20block%20malicious%20content%3A): Provides additional protection by blocking malware sites.
|
||||||
|
* [**Cloudflare_Malware_Adult**](https://developers.cloudflare.com/1.1.1.1/setup/#:~:text=Use%20the%20following%20DNS%20resolvers%20to%20block%20malware%20and%20adult%20content%3A): Blocks both malware and adult content, offering more comprehensive filtering.
|
||||||
|
* [**Level3**](https://www.lumen.com/): Another fast and reliable DNS service option.
|
||||||
|
* [**Open_DNS**](https://www.opendns.com/setupguide/#familyshield): Offers customizable filtering and enhanced security features.
|
||||||
|
* [**Quad9**](https://quad9.net/): Focuses on security by blocking known malicious domains.
|
||||||
|
|
||||||
#### Upgrade All
|
### Customize Preferences
|
||||||
* Press the button to upgrade all installed programs that are supported by WinGet, there is no selection needed.
|
|
||||||
|
|
||||||
#### Uninstall
|
The Customize Preferences section allows users to personalize their Windows experience by toggling various visual and functional features. These preferences are designed to enhance usability and tailor the system to the user’s specific needs and preferences.
|
||||||
* To uninstall programs select the programs you wish to uninstall like the picture below.
|
|
||||||
![Program Uninstall](assets/ProgramInstall.png)
|
|
||||||
* Once you have selected the programs you wish to uninstall click the select Uninstall Selected button as seen below.
|
|
||||||
![Program Uninstall Button](assets/ProgramUninstall.png)
|
|
||||||
|
|
||||||
#### Get Installed
|
### Performance Plans
|
||||||
* Checks for installed programs that are supported by WinGet and selects them in the Utility.
|
|
||||||
|
|
||||||
#### Clear Selection
|
The Performance Plans section allows users to manage the Ultimate Performance Profile on their system. This feature is designed to optimize the system for maximum performance.
|
||||||
* Clears ur current selection so no program is checked.
|
|
||||||
|
|
||||||
### Tweaks
|
#### Add and activate the Ultimate Performance Profile:
|
||||||
|
* Enables and activates the Ultimate Performance Profile to enhance system performance by minimizing latency and increasing efficiency.
|
||||||
|
#### Remove Ultimate Performance Profile:
|
||||||
|
* Deactivates the Ultimate Performance Profile, changing the system to the Balanced Profile.
|
||||||
|
|
||||||
#### Tweaks Addition
|
### Shortcuts
|
||||||
* To enable tweaks on your system select Tweaks at the top next to Install.
|
|
||||||
* Then you can select what tweaks you want adding to your system. We do have some presets you can select from at the top you can see this in the picture below.
|
|
||||||
![Tweaks Screen](assets/TweaksScreen.PNG)
|
|
||||||
* After you have chosen your tweaks click the Run Tweaks button at the bottom of the screen.
|
|
||||||
|
|
||||||
#### Tweaks Removal
|
The utility includes a feature to easily create a desktop shortcut, providing quick access to the script.
|
||||||
* To disable tweaks on your system select Tweaks at the top next to Install.
|
|
||||||
* Then you can select what tweaks you want removing from your system.
|
|
||||||
* After you have chosen your tweaks you want to remove click the Undo Selected Tweaks button at the bottom of the screen.
|
|
||||||
|
|
||||||
#### Essential Tweaks
|
## Config
|
||||||
* The Tweaks under the Essential
|
---
|
||||||
|
|
||||||
#### Advanced Tweaks - CAUTION
|
### Features
|
||||||
|
* Install the most used **Windows Features** by checking the checkbox and clicking "Install Features" to install them.
|
||||||
|
|
||||||
#### O&O Shutup
|
* All .Net Frameworks (2, 3, 4)
|
||||||
|
* HyperV Virtualization
|
||||||
|
* Legacy Media (WMP, DirectPlay)
|
||||||
|
* NFS - Network File System
|
||||||
|
* Enable Search Box Web Suggestions in Registry (explorer restart)
|
||||||
|
* Disables Search Box Web Suggestions in Registry (explorer restart)
|
||||||
|
* Enable Daily Registry Backup Task 12:30am
|
||||||
|
* Enable Legacy F8 Boot Recovery
|
||||||
|
* Disable Legacy F8 Boot Recovery
|
||||||
|
* Windows Subsystem for Linux
|
||||||
|
* Windows Sandbox
|
||||||
|
|
||||||
#### DNS
|
### Fixes
|
||||||
|
* Quick fixes for your system if you are having issues.
|
||||||
#### Customize Preferences
|
|
||||||
|
|
||||||
#### Performance Plans
|
|
||||||
|
|
||||||
#### Shortcuts
|
|
||||||
|
|
||||||
|
|
||||||
![Tweaks Screen](assets/TweaksScreen.PNG)
|
|
||||||
|
|
||||||
### Config
|
|
||||||
|
|
||||||
#### Features
|
|
||||||
* Install the most used Windows Features by checking the checkbox and clicking "Install Features" to install them
|
|
||||||
|
|
||||||
#### Fixes
|
|
||||||
* Quick Fixes for your system if you are having Issues.
|
|
||||||
|
|
||||||
* Set Up Autologin
|
* Set Up Autologin
|
||||||
* Reset Windows Update
|
* Reset Windows Update
|
||||||
@ -75,85 +124,137 @@
|
|||||||
* WinGet Reinstall
|
* WinGet Reinstall
|
||||||
* Remove Adobe Creative Cloud
|
* Remove Adobe Creative Cloud
|
||||||
|
|
||||||
#### Legacy Windows Panels
|
### Legacy Windows Panels
|
||||||
|
|
||||||
### Updates | Not working rn
|
Open old-school Windows panels directly from WinUtil. Following Panels are available:
|
||||||
|
|
||||||
### MicroWin
|
* Control Panel
|
||||||
|
* Network Connections
|
||||||
|
* Power Panel
|
||||||
|
* Region
|
||||||
|
* Sound Settings
|
||||||
|
* System Properties
|
||||||
|
* User Accounts
|
||||||
|
|
||||||
**MicroWin** lets you customize your Windows 10 and 11 installation images by debloating them however you want.
|
## Updates
|
||||||
|
---
|
||||||
|
|
||||||
![MicroWin](assets/MicroWinScreen.png)
|
The utility provides three distinct settings for managing Windows updates: Default (Out of Box) Settings, Security (Recommended) Settings, and Disable ALL Updates (NOT RECOMMENDED!). Each setting offers a different approach to handling updates, catering to various user needs and preferences.
|
||||||
|
|
||||||
|
### Default (Out of Box) Settings
|
||||||
|
- **Description**: This setting retains the default configurations that come with Windows, ensuring no modifications are made.
|
||||||
|
- **Functionality**: It will remove any custom Windows update settings previously applied.
|
||||||
|
- **Note**: If update errors persist, reset all updates in the configuration tab to restore all Microsoft Update Services to their default settings, reinstalling them from their servers.
|
||||||
|
|
||||||
|
### Security (Recommended) Settings
|
||||||
|
- **Description**: This is the recommended setting for all computers.
|
||||||
|
- **Update Schedule**:
|
||||||
|
- **Feature Updates**: Delays feature updates by 2 years to avoid potential bugs and instability.
|
||||||
|
- **Security Updates**: Installs security updates 4 days after their release to ensure system protection against pressing security flaws.
|
||||||
|
- **Rationale**:
|
||||||
|
- **Feature Updates**: Often introduce new features and bugs; delaying these updates minimizes the risk of system disruptions.
|
||||||
|
- **Security Updates**: Essential for patching critical security vulnerabilities. Delaying them by a few days allows for verification of stability and compatibility without leaving the system exposed for extended periods.
|
||||||
|
|
||||||
|
### Disable ALL Updates (NOT RECOMMENDED!)
|
||||||
|
- **Description**: This setting completely disables all Windows updates.
|
||||||
|
- **Suitability**: May be appropriate for systems used for specific purposes that do not require active internet browsing.
|
||||||
|
- **Warning**: Disabling updates significantly increases the risk of the system being hacked or infected due to the lack of security patches.
|
||||||
|
- **Note**: It is strongly advised against using this setting due to the heightened security risks.
|
||||||
|
|
||||||
|
!!! bug
|
||||||
|
|
||||||
|
The Updates tab is currently non-functional. We are actively working on a resolution to restore its functionality.
|
||||||
|
|
||||||
|
## MicroWin
|
||||||
|
---
|
||||||
|
|
||||||
|
* **MicroWin** lets you customize your Windows 10 and 11 installation images by debloating them however you want.
|
||||||
|
|
||||||
|
![Microwin](assets/Microwin-Dark.png#only-dark)
|
||||||
|
![Microwin](assets/Microwin-Light.png#only-light)
|
||||||
|
|
||||||
#### Basic usage
|
#### Basic usage
|
||||||
|
|
||||||
1. Specify the source Windows ISO to customize
|
1. Specify the source Windows ISO to customize.
|
||||||
|
|
||||||
* If you don't have a Windows ISO file prepared, you can download it using the Media Creation Tool for the respective Windows version. [Here](https://go.microsoft.com/fwlink/?linkid=2156295) is the Windows 11 version, and [here](https://go.microsoft.com/fwlink/?LinkId=2265055) is the Windows 10 version
|
* If you don't have a Windows ISO file prepared, you can download it using the Media Creation Tool for the respective Windows version. [Here](https://go.microsoft.com/fwlink/?linkid=2156295) is the Windows 11 version, and [here](https://go.microsoft.com/fwlink/?LinkId=2265055) is the Windows 10 version
|
||||||
|
|
||||||
2. Configure the debloat process
|
2. Configure the debloat process.
|
||||||
3. Specify the target location for the new ISO file
|
3. Specify the target location for the new ISO file.
|
||||||
4. Let the magic happen!
|
4. Let the magic happen!
|
||||||
|
|
||||||
**NOTE:** this feature is still in development and you may encounter some issues with the generated images. If that happens, don't hesitate to report an issue!
|
!!! warning "Heads-up"
|
||||||
|
|
||||||
|
This feature is still in development, and you may encounter some issues with the generated images. If that happens, don't hesitate to report an issue!
|
||||||
|
|
||||||
#### Options
|
#### Options
|
||||||
|
|
||||||
* **Download oscdimg.exe from CTT GitHub repo** will grab a OSCDIMG executable from the GitHub repository instead of a Chocolatey package
|
* **Download oscdimg.exe from the CTT GitHub repo** will grab an OSCDIMG executable from the GitHub repository instead of a Chocolatey package.
|
||||||
|
|
||||||
|
!!! info
|
||||||
|
|
||||||
OSCDIMG is the tool that lets the program create ISO images. Typically, you would find this in the [Windows Assessment and Deployment Kit](https://learn.microsoft.com/en-us/windows-hardware/get-started/adk-install)
|
OSCDIMG is the tool that lets the program create ISO images. Typically, you would find this in the [Windows Assessment and Deployment Kit](https://learn.microsoft.com/en-us/windows-hardware/get-started/adk-install)
|
||||||
|
|
||||||
* Selecting a scratch directory will copy the contents of the ISO file to the directory you specify instead of an automatically generated folder on the `%TEMP%` directory
|
* Selecting a scratch directory will copy the contents of the ISO file to the directory you specify instead of an automatically generated folder in the `%TEMP%` directory.
|
||||||
* You can select an edition of Windows to debloat (**SKU**) using the convenient drop-down menu
|
* You can select an edition of Windows to debloat (**SKU**) using the convenient drop-down menu.
|
||||||
|
|
||||||
By default, MicroWin will debloat the Pro edition, but you can choose any edition you want
|
By default, MicroWin will debloat the Pro edition, but you can choose any edition you want.
|
||||||
|
|
||||||
|
|
||||||
##### Customization options
|
##### Customization options
|
||||||
|
|
||||||
* **Keep Provisioned Packages**: leaving this option unticked (default) will try to remove every operating system package
|
* **Keep Provisioned Packages**: leaving this option unticked (default) will try to remove every operating system package.
|
||||||
|
|
||||||
Some packages may remain after processing. This can happen if the packages in question were permanent ones or had been superseded by newer versions
|
Some packages may remain after processing. This can happen if the packages in question are permanent or have been superseded by newer versions.
|
||||||
|
|
||||||
* **Keep Appx Packages**: leaving this option unticked (default) will try to remove every Microsoft Store app from the Windows image
|
* **Keep Appx Packages**: leaving this option unticked (default) will try to remove every Microsoft Store app from the Windows image.
|
||||||
|
|
||||||
This option will exclude some applications that are essential in the case that you want or need to add a Store app later on
|
This option will exclude some applications that are essential in the event that you want or need to add a Store app later on.
|
||||||
|
|
||||||
* **Keep Defender**: leaving this option unticked will try to remove every part of Windows Defender, including the Windows Security app
|
* **Keep Defender**: leaving this option unticked will try to remove every part of Windows Defender, including the Windows Security app.
|
||||||
|
|
||||||
Leaving this option unticked is **NOT recommended** unless you plan to use a third-party antivirus solution on your MicroWin installation. On that regard, don't install AVs with bad reputation or rogueware
|
Leaving this option unticked is **NOT recommended** unless you plan to use a third-party antivirus solution on your MicroWin installation. In that regard, don't install AVs with bad reputations or rogueware.
|
||||||
|
|
||||||
* **Keep Edge**: leaving this option unticked will try to remove every part of the Microsoft Edge browser using the best methods available
|
* **Keep Edge**: leaving this option unticked will try to remove every part of the Microsoft Edge browser using the best methods available.
|
||||||
|
|
||||||
Leaving this option unticked is not recommended because it might break some applications that might depend on the `Edge WebView2` runtime. However, if that happens, you can easily [reinstall it](https://developer.microsoft.com/en-us/microsoft-edge/webview2)
|
Leaving this option unticked is not recommended because it might break some applications that might depend on the `Edge WebView2` runtime. However, if that happens, you can easily [reinstall it](https://developer.microsoft.com/en-us/microsoft-edge/webview2)
|
||||||
|
|
||||||
|
|
||||||
##### Driver integration options
|
##### Driver integration options
|
||||||
|
|
||||||
* **Inject drivers** will add the drivers in the folder that you specify to the target Windows image
|
* **Inject drivers** will add the drivers in the folder that you specify to the target Windows image.
|
||||||
* **Import drivers from current system** will add every third-party driver that is present in your active installation
|
* **Import drivers from the current system** will add every third-party driver that is present in your active installation.
|
||||||
|
|
||||||
This makes the target image have the same hardware compatibility of the active installation. However, this means that you will only be able to install the target Windows image and take full advantage of it on computers with **the same hardware**. To avoid this, you'll need to customize the `install.wim` file of the target ISO in the `sources` folder
|
This makes the target image have the same hardware compatibility as the active installation. However, this means that you will only be able to install the target Windows image and take full advantage of it on computers with **the same hardware**. To avoid this, you'll need to customize the `install.wim` file of the target ISO in the 'sources` folder.
|
||||||
|
|
||||||
|
|
||||||
##### Ventoy options
|
##### Ventoy options
|
||||||
|
|
||||||
* **Copy to Ventoy** will copy the target ISO file to any USB drive with [Ventoy](https://ventoy.net/en/index.html) installed
|
* **Copy to Ventoy** will copy the target ISO file to any USB drive with [Ventoy](https://ventoy.net/en/index.html) installed
|
||||||
|
!!! info
|
||||||
|
|
||||||
Ventoy is a solution that lets you boot to any ISO file stored in a drive. Think of it as having multiple bootable USBs in one. Do note though that your drive needs to have enough free space for the target ISO file
|
Ventoy is a solution that lets you boot to any ISO file stored on a drive. Think of it as having multiple bootable USBs in one. Do note, though, that your drive needs to have enough free space for the target ISO file.
|
||||||
|
|
||||||
|
|
||||||
## Automation
|
## Automation
|
||||||
|
|
||||||
* Some features are available through automation. This allows you to save your config file pass it to Winutil walk away and come back to a finished system. Here is how you can set it up currently with Winutil >24.01.15
|
* Some features are available through automation. This allows you to save your config file, pass it to WinUtil, walk away and come back to a finished system. Here is how you can set it up currently with Winutil >24.01.15
|
||||||
|
|
||||||
* On the Install Tab, click "Get Installed", this will get all installed apps **supported by Winutil** on the system
|
* On the Install Tab, click "Get Installed", this will get all installed apps **supported by Winutil** on the system.
|
||||||
![GetInstalled](assets/Get-Installed.png)
|
![GetInstalled](assets/Get-Installed-Dark.png#only-dark)
|
||||||
* Click on the Settings cog in the upper right corner and chose Export, chose file file and location, this will export the setting file.
|
![GetInstalled](assets/Get-Installed-Light.png#only-light)
|
||||||
![SettingsExport](assets/Settings-Export.png)
|
|
||||||
* Copy this file to a USB or somewhere you can use after Windows installation.
|
* Click on the Settings cog in the upper right corner and choose Export. Choose file file and location; this will export the setting file.
|
||||||
* Use Microwin tab to create a custom Windows image.
|
![SettingsExport](assets/Settings-Export-Dark.png#only-dark)
|
||||||
* Install the Windows image.
|
![SettingsExport](assets/Settings-Export-Light.png#only-light)
|
||||||
* In the new Windows, Open PowerShell in the admin mode and run command to automatically apply tweaks and install apps from the config file.
|
|
||||||
* ``` iex "& { $(irm christitus.com/win) } -Config [path-to-your-config] -Run" ```
|
* Copy this file to a USB or somewhere you can use it after Windows installation.
|
||||||
|
|
||||||
|
!!! tip
|
||||||
|
|
||||||
|
Use the Microwin tab to create a custom Windows image & install the Windows image.
|
||||||
|
|
||||||
|
* On any supported Windows machine, open PowerShell **as Admin** and run the following command to automatically apply tweaks and install apps from the config file.
|
||||||
|
```ps1
|
||||||
|
iex "& { $(irm christitus.com/win) } -Config [path-to-your-config] -Run"
|
||||||
|
```
|
||||||
* Have a cup of coffee! Come back when it's done.
|
* Have a cup of coffee! Come back when it's done.
|
24
mkdocs.yml
@ -40,5 +40,27 @@ theme:
|
|||||||
name: Switch to light mode
|
name: Switch to light mode
|
||||||
primary: teal
|
primary: teal
|
||||||
accent: lime
|
accent: lime
|
||||||
markdown_extensions:
|
markdown_extensions:
|
||||||
- admonition
|
- admonition
|
||||||
|
- pymdownx.details
|
||||||
|
- pymdownx.superfences
|
||||||
|
- pymdownx.superfences:
|
||||||
|
custom_fences:
|
||||||
|
- name: mermaid
|
||||||
|
class: mermaid
|
||||||
|
format: !!python/name:pymdownx.superfences.fence_code_format
|
||||||
|
- abbr
|
||||||
|
- attr_list
|
||||||
|
- pymdownx.snippets
|
||||||
|
- md_in_html
|
||||||
|
- pymdownx.superfences
|
||||||
|
- pymdownx.tabbed:
|
||||||
|
alternate_style: true
|
||||||
|
- pymdownx.highlight:
|
||||||
|
anchor_linenums: true
|
||||||
|
line_spans: __span
|
||||||
|
pygments_lang_class: true
|
||||||
|
- pymdownx.inlinehilite
|
||||||
|
- def_list
|
||||||
|
- pymdownx.tasklist:
|
||||||
|
custom_checkbox: true
|