Skip to content

Commit cb2d6f2

Browse files
committed
Updated readmes
1 parent 9f2e2b9 commit cb2d6f2

File tree

9 files changed

+218
-252
lines changed

9 files changed

+218
-252
lines changed

README.md

Lines changed: 54 additions & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ This page is also available in other languages
5555
<a href="./docs/README_de-de.md"><img src="https://raw.githubusercontent.com/farag2/Sophia-Script-for-Windows/refs/heads/master/img/germany.png" height="70px"/></a>
5656
<a href="./docs/README_ru-ru.md"><img src="https://raw.githubusercontent.com/farag2/Sophia-Script-for-Windows/refs/heads/master/img/russia.png" height="70px"/></a>
5757

58-
<img src="./img/SophiaScript.png" alt="Sophia Script for Windows" width='800'>
58+
<img src="./img/SophiaScript.gif" width='800'>
5959

6060
</div>
6161

@@ -64,48 +64,49 @@ This page is also available in other languages
6464
`Sophia Script for Windows` is the most powerful PowerShell module for fine-tuning `Windows` and automating the routine tasks on `GitHub`. It offers more than 150 unique tweaks, and shows how Windows can be configured without making any harm to it.
6565

6666
> [!IMPORTANT]
67-
> Every tweak in the preset file has its' corresponding function to restore the default settings.
67+
> Every tweak in the preset file has its corresponding function to restore default settings.
6868
6969
## Key features
7070

71-
* All archives are being built via GitHub Actions [automatically](https://github.com/farag2/Sophia-Script-for-Windows/actions);
72-
* Has no conflict with [VAC](https://help.steampowered.com/faqs/view/571A-97DA-70E9-FF74#whatisvac);
73-
* Set up Privacy & Telemetry;
74-
* Enable DNS-over-HTTPS for IPv4;
75-
* Turn off diagnostics tracking scheduled tasks with pop-up form written in [WPF](#screenshots);
76-
* Set up UI & Personalization;
77-
* Uninstall OneDrive "correctly";
78-
* Interactive [prompts](#change-user-folders-location-programmatically-using-the-interactive-menu);
79-
* The <kbd>TAB</kbd> [completion](#the-tab-autocomplete-read-more-here) for functions and their arguments (if using the Import-TabCompletion.ps1 file);
71+
* Fully open-source project
72+
* All archives are being built and uploaded using GitHub Actions [automatically](https://github.com/farag2/Sophia-Script-for-Windows/actions)
73+
* Cursors from [Jepri Creations](https://www.deviantart.com/jepricreations/art/Windows-11-Cursors-Concept-v2-886489356) was downloaded using [DeviantArt API](https://github.com/farag2/Sophia-Script-for-Windows/blob/master/.github/workflows/Cursors.yml)
74+
* Available via scoop, Chocolatey, and WinGet
75+
* Has no conflict with [VAC](https://help.steampowered.com/faqs/view/571A-97DA-70E9-FF74#whatisvac)
76+
* Configure Windows privacy
77+
* Configure Windows security
78+
* Personalize Windows UI
79+
* Display applied registry policies in the Local Group Policy Editor snap-in (gpedit.msc)
80+
* Enable DNS-over-HTTPS for IPv4
81+
* Turn off diagnostics tracking scheduled tasks with pop-up form written in [WPF](#screenshots)
82+
* Uninstall OneDrive "correctly"
83+
* Interactive [prompts](#change-user-folders-location-programmatically-using-the-interactive-menu)
84+
* The <kbd>TAB</kbd> [completion](#the-tab-autocomplete-read-more-here) for functions and their arguments (if using the Import-TabCompletion.ps1 file)
8085
* Change location of the user folders programmatically (without moving user files) within interactive menu using arrows to select a drive
8186
* Desktop
8287
* Documents
8388
* Downloads
8489
* Music
8590
* Pictures
8691
* Videos
87-
* Install free (light and dark) "Windows 11 Cursors Concept v2" cursors from [Jepri Creations](https://www.deviantart.com/jepricreations/art/Windows-11-Cursors-Concept-v2-886489356) on-the-fly;
88-
* Uninstall UWP apps displaying their localized packages names;
92+
* Install free (light and dark) "Windows 11 Cursors Concept v2" cursors from [Jepri Creations](https://www.deviantart.com/jepricreations/art/Windows-11-Cursors-Concept-v2-886489356) on-the-fly
93+
* Uninstall UWP apps displaying their localized packages names
8994
* Script generates installed UWP apps list [dynamically](#localized-uwp-packages-names)
90-
* Disable Windows features displaying friendly packages names with pop-up form written in [WPF](#screenshots);
91-
* Uninstall Windows capabilities displaying friendly packages names with pop-up form written in [WPF](#screenshots);
92-
* Download and install the [HEVC Video Extensions from Device Manufacturer](https://apps.microsoft.com/detail/9N4WGH0Z6VHQ) to be able to open [HEVC](https://en.wikipedia.org/wiki/High_Efficiency_Video_Coding) format;
93-
* Set an app as default one for specific extension without the "How do you want to open this" pop-up using special [function](https://github.com/DanysysTeam/PS-SFTA);
94-
* Export all Windows associations. Associations will be exported as Application_Associations.json file in script root folder;
95-
* Import exported JSON file after a clean installation. You need to install all apps according to exported JSON file to restore all associations;
96-
* Install any supported Linux distribution for WSL displaying friendly distro names with pop-up form written in [WPF](#screenshots);
97-
* Create scheduled tasks with a native toast notification, where you will be able to run or [dismiss](#native-interactive-toasts-for-the-scheduled-tasks) tasks;
98-
* Create scheduled tasks `Windows Cleanup` and `Windows Cleanup Notification` for cleaning up Windows of unused files and Windows updates files;
99-
* Create a scheduled task `SoftwareDistribution` for cleaning up `%SystemRoot%\SoftwareDistribution\Download`;
100-
* Create a scheduled task `Temp` for cleaning up `%TEMP%`.
95+
* Download and install the [HEVC Video Extensions from Device Manufacturer](https://apps.microsoft.com/detail/9N4WGH0Z6VHQ) to be able to open [HEVC](https://en.wikipedia.org/wiki/High_Efficiency_Video_Coding) format
96+
* Set an app as default one for specific extension without the "How do you want to open this" pop-up using special [function](https://github.com/DanysysTeam/PS-SFTA)
97+
* Export all Windows associations. Associations will be exported as Application_Associations.json file in script root folder
98+
* Import exported JSON file after a clean installation. You need to install all apps according to exported JSON file to restore all associations
99+
* Install any supported Linux distribution for WSL displaying friendly distro names with pop-up form written in [WPF](#screenshots)
100+
* Create scheduled tasks with a native toast notification, where you will be able to run or [dismiss](#native-interactive-toasts-for-the-scheduled-tasks) tasks
101+
* Create scheduled tasks `Windows Cleanup` and `Windows Cleanup Notification` for cleaning up Windows of unused files and Windows updates files
102+
* Create a scheduled task `SoftwareDistribution` for cleaning up `%SystemRoot%\SoftwareDistribution\Download`
103+
* Create a scheduled task `Temp` for cleaning up `%TEMP%`
101104
* Create tasks in the Task Scheduler to clear
102105
* `%SystemRoot%\SoftwareDistribution\Download`
103106
* `%TEMP%`
104-
* Install the latest provided Microsoft Visual C++ 2015–2026 x86/x64 (ARM64 supported);
105-
* Install the latest provided .NET Desktop Runtime 8, 9, 10 x64;
106-
* Configure Windows security;
107-
* Display applied registry policies in the Local Group Policy Editor snap-in (gpedit.msc);
108-
* Many more File Explorer and context menu "deep" tweaks.
107+
* Install the latest provided Microsoft Visual C++ 2015–2026 x86/x64 (ARM64 supported)
108+
* Install the latest provided .NET Desktop Runtime 8, 9, 10 x64
109+
* Many more File Explorer and context menu "deep" tweaks
109110

110111
## Table of Contents
111112

@@ -206,23 +207,23 @@ scoop uninstall sophia-script --purge
206207

207208
## How to use
208209

209-
* Download archive and expand it;
210-
* Look through the `Sophia.ps1` file to configure functions that you want to be run;
210+
* Download archive and expand it
211+
* Look through the `Sophia.ps1` file to configure functions that you want to be run
211212
* Place the `#` char before function if you don't want it to be run.
212213
* Remove the `#` char before function if you want it to be run.
213214
* Copy the whole path to `Sophia.ps1`
214-
* On `Windows 10` press and hold the <kbd>Shift</kbd> key, right click on `Sophia.ps1`, and click on `Copy as path`;
215+
* On `Windows 10` press and hold the <kbd>Shift</kbd> key, right click on `Sophia.ps1`, and click on `Copy as path`
215216
* On `Windows 11` right click on `Sophia.ps1` and click on `Copy as path`.
216217
* Open `Windows PowerShell`
217218
* On `Windows 10` click `File` in the File Explorer, hover over `Open Windows PowerShell`, and select `Open Windows PowerShell as Administrator` [(how-to with screenshots)](https://www.howtogeek.com/662611/9-ways-to-open-powershell-in-windows-10/)
218-
* On `Windows 11` right-click on the <kbd>Windows</kbd> icon and open `Windows Terminal (Admin)`;
219-
* Set execution policy to be able to run scripts only in the current PowerShell session;
219+
* On `Windows 11` right-click on the <kbd>Windows</kbd> icon and open `Windows Terminal (Admin)`
220+
* Set execution policy to be able to run scripts only in the current PowerShell session
220221

221222
```powershell
222223
Set-ExecutionPolicy -ExecutionPolicy Bypass -Scope Process -Force
223224
```
224225

225-
* Type `.\Sophia.ps1`and press <kbd>Enter</kbd>;
226+
* Type `.\Sophia.ps1`and press <kbd>Enter</kbd>
226227

227228
```powershell
228229
.\Sophia.ps1
@@ -238,15 +239,15 @@ scoop uninstall sophia-script --purge
238239

239240
### How to run the specific function(s)
240241

241-
* Do all steps from [How to use](#how-to-use) section and stop at setting execution policy in `PowerShell`;
242+
* Do all steps from [How to use](#how-to-use) section and stop at setting execution policy in `PowerShell`
242243
* [Dot source](https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_operators#dot-sourcing-operator-) the `Import-TabCompletion.ps1` file first:
243244

244245
```powershell
245246
# With a dot at the beginning
246247
. .\Import-TabCompletion.ps1
247248
```
248249

249-
* Now you can do like this (the quotation marks required)
250+
* Сall any script function with name autocompletion using <kbd>TAB</kbd>
250251

251252
```powershell
252253
Sophia -Functions<TAB>
@@ -258,27 +259,27 @@ Sophia -Functions "DiagTrackService -Disable", "DiagnosticDataLevel -Minimal", U
258259
Uninstall-UWPApps, "PinToStart -UnpinAll"
259260
```
260261

261-
<https://github.com/user-attachments/assets/ea90122a-bdb3-4687-bf8b-9b6e7af46826>
262+
<https://github.com/user-attachments/assets/b7ba9ff5-fa3f-481c-a91f-d8bac5631a56>
262263

263264
## Wrapper
264265

265266
![Image](https://github.com/farag2/Sophia-Script-for-Windows/raw/master/img/Wrapper.png)
266267

267268
Read more [here](./Wrapper/README.md)
268269

269-
@BenchTweakGaming
270+
[@BenchTweakGaming](https://github.com/BenchTweakGaming)
270271

271-
* Download the [latest](https://github.com/farag2/Sophia-Script-for-Windows/releases/latest) Wrapper version;
272-
* Expand archive;
273-
* Run `SophiaScriptWrapper.exe` and import `Sophia.ps1`;
274-
* `Sophia.ps1` has to be in `Sophia Script` folder;
275-
* The Wrapper has a real time UI rendering;
276-
* Configure every function;
272+
* Download the [latest](https://github.com/farag2/Sophia-Script-for-Windows/releases/latest) Wrapper version
273+
* Expand archive
274+
* Run `SophiaScriptWrapper.exe` and import `Sophia.ps1`
275+
* `Sophia.ps1` has to be in `Sophia Script` folder
276+
* The Wrapper has a real time UI rendering
277+
* Configure every function
277278
* Open the `Console Output` tab and press `Run PowerShell`.
278279

279280
## How to revert changes
280281

281-
* Do all steps from [How to use](#how-to-use) section and stop at setting execution policy in `PowerShell`;
282+
* Do all steps from [How to use](#how-to-use) section and stop at setting execution policy in `PowerShell`
282283
* [Dot source](https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_operators#dot-sourcing-operator-) the `Import-TabCompletion.ps1` file first:
283284

284285
```powershell
@@ -314,22 +315,10 @@ Sophia -Functions "DiagTrackService -Enable", Uninstall-UWPApps
314315

315316
## Screenshots
316317

317-
### The <kbd>TAB</kbd> autocomplete. Read more [here](#how-to-run-the-specific-functions)
318-
319-
https://user-images.githubusercontent.com/10544660/225270281-908abad1-d125-4cae-a19b-2cf80d5d2751.mp4
320-
321-
### Change user folders location programmatically using the interactive menu
322-
323-
https://user-images.githubusercontent.com/10544660/253818031-b7ce6bf1-d968-41ea-a5c0-27f6845de402.mp4
324-
325318
### Localized UWP packages names
326319

327320
![Image](./img/uwpapps.png)
328321

329-
### Localized Windows features names
330-
331-
![Image](./img/optionalfeatures.png) ![Image](./img/windowsfeatures.png)
332-
333322
### Download and install any supported Linux distribution in automatic mode
334323

335324
![Image](./img/WSL.png)
@@ -340,14 +329,16 @@ https://user-images.githubusercontent.com/10544660/253818031-b7ce6bf1-d968-41ea-
340329

341330
## Videos
342331

343-
[![YT](https://img.youtube.com/vi/q_weQifFM58/0.jpg)](https://www.youtube.com/watch?v=q_weQifFM58)
332+
[Video Tutorial](https://www.youtube.com/watch?v=q_weQifFM58)
333+
334+
[Chris Titus Tech' Review](https://youtu.be/8E6OT_QcHaU?t=370)
344335

345-
[![YT](https://img.youtube.com/vi/8E6OT_QcHaU/1.jpg)](https://youtu.be/8E6OT_QcHaU?t=370) [![YT](https://img.youtube.com/vi/091SOihvx0k/1.jpg)](https://youtu.be/091SOihvx0k?t=490)
336+
[Znorux' Review](https://youtu.be/091SOihvx0k?t=490)
346337

347338
## How to translate
348339

349-
* Get your OS UI culture by invoking `$PSUICulture` in PowerShell;
350-
* Create a folder with the UI culture name;
340+
* Get your OS UI culture by invoking `$PSUICulture` in PowerShell
341+
* Create a folder with the UI culture name
351342
* Place your localized SophiaScript.psd1 file into this folder.
352343

353344
## Media
@@ -368,7 +359,7 @@ https://user-images.githubusercontent.com/10544660/253818031-b7ce6bf1-d968-41ea-
368359

369360
***
370361

371-
## SophiApp 2 (C# + WinUI 3)
362+
## SophiApp 2.0 (C# + WinUI 3)
372363

373364
[SophiApp 2.0](https://github.com/Sophia-Community/SophiApp) is in ongoing development. 🚀
374365

0 commit comments

Comments
 (0)