Browse Source

Update README.md

pull/23/head
farag2 5 years ago
committed by GitHub
parent
commit
dd77358f11
No known key found for this signature in database GPG Key ID: 4AEE18F83AFDEB23
  1. 43
      README.md

43
README.md

@ -1,25 +1,10 @@
Windows 10 Setup Script
========================================================
<div align="center">
<h1>Windows 10 Setup Script</h1>
## Contents
- [Overview](#overview)
- [Supported Windows version](#supported-windows-version)
- [Core features](#core-features)
- [Nota bene](#NB)
- [Usage](#usage)
- [FAQ](#faq)
- [Intro](#intro)
- [Microsoft Docs](#Microsoft-Docs)
- [PS](#ps)
## Overview
The PowerShell script is a set of tweaks for OS fine-tuning and automating the routine tasks.
[![Downloads](https://img.shields.io/github/downloads/farag2/Windows-10-Setup-Script/total?style=for-the-badge)](https://github.com/farag2/Windows-10-Setup-Script/releases)
## Supported Windows versions
|Version|Code name| Marketing name |Build| Arch | Editions |
|:-----:|:-------:|:------------------:|:---:|:------:|:------------:|
| 1909 | 19H2 |November 2019 Update|18363|x64 only|Pro/Enterprise|
| 1903 | 19H1 | May 2019 Update |18362|x64 only|Pro/Enterprise|
Windows 10 Setup Script is a set of tweaks for OS fine-tuning and automating the routine tasks.
</div>
## Core features
- Turn off diagnostics tracking services;
@ -43,19 +28,19 @@ The PowerShell script is a set of tweaks for OS fine-tuning and automating the r
- Refresh desktop icons, environment variables and taskbar without restarting File Explorer;
- Many more File Explorer and context menu "deep" tweaks.
## NB
- PowerShell and PowerShell ISE must be run with elevated privileges;
- Set PowerShell execution policy <code>Set-ExecutionPolicy -ExecutionPolicy Bypass -Force</code> to be able to run .ps1 files.
- Read more about [execution policy](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_execution_policies)
## Usage
To run the script:
- Download [up-to-date version](https://github.com/farag2/Setup-Windows-10/releases);
- Check whether file is encoded in **UTF-8 with BOM** and run it through powershell.exe.
or
- Check whether file is encoded in **UTF-8 with BOM** and run it through powershell.exe;
- PowerShell must be run with elevated privileges;
- Set PowerShell execution policy <code>Set-ExecutionPolicy -ExecutionPolicy Bypass -Force</code> to be able to run .ps1 files.
- Read more about [execution policy](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_execution_policies)
- Copy the script code and paste it into [PowerShell ISE](https://docs.microsoft.com/en-us/powershell/scripting/components/ise/windows-powershell-integrated-scripting-environment--ise-).
## Supported Windows versions
|Version|Code name| Marketing name |Build| Arch | Editions |
|:-----:|:-------:|:------------------:|:---:|:------:|:------------:|
| 1909 | 19H2 |November 2019 Update|18363|x64 only|Pro/Enterprise|
| 1903 | 19H1 | May 2019 Update |18362|x64 only|Pro/Enterprise|
## FAQ
Read the code you run carefully. Some functions are presented as an example only. You must be aware of the meaning of the functions in the code. **If you're not sure what the script does, do not run it**.

Loading…
Cancel
Save