Update README.md

This commit is contained in:
Zoran Jankov 2020-10-23 12:39:38 +02:00 committed by GitHub
parent a654a4571b
commit d1c3fa3923
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -1,6 +1,9 @@
# Windows10Debloater
[![made-with-powershell](https://img.shields.io/badge/PowerShell-1f425f?logo=Powershell)](https://microsoft.com/PowerShell)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
Script/Utility/Application to debloat Windows 10
## Disclaimer
@ -11,6 +14,7 @@ I do ***NOT*** take responsibility for what may happen to your system. This is a
There are different methods of running the PowerShell script. The methods are as follows:
### First Method:
1) Download the .zip file on the main page of the github and extract the .zip file to your desired location
@ -35,7 +39,7 @@ Remember this script NEEDS to be run as admin in order to function properly.
## How To Run the Windows10SysPrepDebloater.ps1 file
For the WindowsSysPrepDebloater.ps1 file, there are a couple of parameters that you can run so that you can specify which functions are used. The parameters are:
`-SysPrep, -Debloat`.
`-SysPrep, -Debloat`.
To run this with parameters, do the following:
@ -51,15 +55,16 @@ To run this with parameters, do the following:
There are now 3 versions of my Windows10Debloater - There is an interactive version, a GUI app version, and a pure silent version.
Windows10SysPrepDebloater.ps1 - The silent version now utilizes the switch parameters: -Sysprep, -Debloat -Privacy. The silent version can be useful for deploying MDT Images/sysprepping or any other way you deploy Windows 10. This will work to remove the bloatware during the deployment process.
`Windows10SysPrepDebloater.ps1` - The silent version now utilizes the switch parameters: -Sysprep, -Debloat -Privacy. The silent version can be useful for deploying MDT Images/sysprepping or any other way you deploy Windows 10. This will work to remove the bloatware during the deployment process.
Windows10Debloater.ps1 - This interactive version is what it implies - a Windows10Debloater script with interactive prompts. This one should not be used for deployments that require a silent script with optional parameters. This script gives you choices with prompts as it runs so that you can make the choices of what the script does.
`Windows10Debloater.ps1` - This interactive version is what it implies - a Windows10Debloater script with interactive prompts. This one should not be used for deployments that require a silent script with optional parameters. This script gives you choices with prompts as it runs so that you can make the choices of what the script does.
**`Windows10DebloaterGUI.ps1`** There is now a GUI Application named Windows10DebloaterGUI.ps1 with buttons to perform all of the functions that the scripts do. This is better for the average user who does not want to work with code, or if you'd prefer to just see an application screen.
Windows10DebloaterGUI.ps1 There is now a GUI Application named Windows10DebloaterGUI.ps1 with buttons to perform all of the functions that the scripts do. This is better for the average user who does not want to work with code, or if you'd prefer to just see an application screen.
## Switch Parameters
There are 3 switch parameters in the Windows10SysPrepDebloater.ps1 script.
There are 3 switch parameters in the `Windows10SysPrepDebloater.ps1` script.
The first one is -SysPrep, which runs the command within a function: get-appxpackage | remove-appxpackage. This is useful since some administrators need that command to run first in order for machines to be able to properly provision the apps for removal.
@ -69,9 +74,10 @@ Remove-Keys removes registry keys leftover that are associated with the bloatwar
Third, Protect-Privacy adds and/or changes registry keys to stop some telemetry functions, stops Cortana from being used as your Search Index, disables "unneccessary" scheduled tasks, and more.
**This script will remove the bloatware from Windows 10 when using Remove-AppXPackage/Remove-AppXProvisionedPackage, and then delete specific registry keys that are were not removed beforehand. For best results, this script should be ran before a user profile is configured, otherwise you will likely see that apps that should have been removed will remain, and if they are removed you will find broken tiles on the start menu**.
***This script will remove the bloatware from Windows 10 when using Remove-AppXPackage/Remove-AppXProvisionedPackage, and then delete specific registry keys that are were not removed beforehand. For best results, this script should be ran before a user profile is configured, otherwise you will likely see that apps that should have been removed will remain, and if they are removed you will find broken tiles on the start menu.***
These registry keys are:
### These registry keys are:
EclipseManager,
ActiproSoftwareLLC,
@ -80,14 +86,15 @@ Microsoft.XboxGameCallableUI
You can choose to either 'Debloat' or 'Revert'. Depending on your choice, either one will run specific code to either debloat your Windows 10 machine.
The Debloat switch choice runs the following functions:
### The Debloat switch choice runs the following functions:
Debloat,
Remove-Keys,
Protect-Privacy,
Stop-EdgePDF (If chosen)
The Revert switch choice runs the following functions:
### The Revert switch choice runs the following functions:
Revert-Changes,
Enable-EdgePDF