Update README.md

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

View File

@ -1,15 +1,17 @@
# Warning
I do *not* take responsibility for what may happen to your system. This is at your own risk.
# Windows10Debloater
Script/Utility/Application to debloat Windows 10
# How To Run the Windows10Debloater.ps1 and the Windows10DebloaterGUI.ps1 files
## Disclaimer
I do ***not*** take responsibility for what may happen to your system. This is at your own risk.
## How To Run the Windows10Debloater.ps1 and the Windows10DebloaterGUI.ps1 files
There are different methods of running the PowerShell script. The methods are as follows:
First Method:
### First Method:
1) Download the .zip file on the main page of the github and extract the .zip file to your desired location
2) Once extracted, open PowerShell (or PowerShell ISE) as an Administrator
@ -21,7 +23,7 @@ First Method:
e.g. - `.\Windows10DebloaterGUI.ps1`
Second Method:
### Second Method:
1) Download the .zip file on the main page of the github and extract the .zip file to your desired location
2) Right click the PowerShell file that you'd like to run and click on "Run With PowerShell"
@ -30,7 +32,7 @@ Second Method:
Remember this script NEEDS to be run as admin in order to function properly.
# How To Run the Windows10SysPrepDebloater.ps1 file
## 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`.
@ -45,7 +47,7 @@ To run this with parameters, do the following:
e.g. - `.\Windows10SysPrepDebloater.ps1 -Sysprep, -Debloat -Privacy`
# Sysprep, Interactive, and GUI Application
## Sysprep, Interactive, and GUI Application
There are now 3 versions of my Windows10Debloater - There is an interactive version, a GUI app version, and a pure silent version.
@ -55,7 +57,7 @@ Windows10Debloater.ps1 - This interactive version is what it implies - a Windows
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
## Switch Parameters
There are 3 switch parameters in the Windows10SysPrepDebloater.ps1 script.
@ -67,7 +69,7 @@ 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:
@ -92,7 +94,7 @@ Enable-EdgePDF
The Revert option reinstalls the bloatware and changes your registry keys back to default.
# The scheduled tasks that are disabled are:
## The scheduled tasks that are disabled are:
XblGameSaveTaskLogon,
XblGameSaveTask,
@ -102,7 +104,7 @@ DmClient
These scheduled tasks that are disabled have absolutely no impact on the function of the OS.
# Bloatware that is removed:
## Bloatware that is removed:
3DBuilder,
ActiproSoftware,
@ -169,10 +171,10 @@ Xbox Identity Provider,
Zune Music,
Zune Video.
# Quick download link
## Quick download link
`iex ((New-Object System.Net.WebClient).DownloadString('https://git.io/debloat'))`
# Credits
## Credits
Thank you to a60wattfish, abulgatz, xsisbest, Damian, Vikingat-RAGE, and Reddit user /u/GavinEke for some of the suggestions and fixes that I have placed into my scripts. You all have done a fantastic job!