mirror of
https://github.com/ChrisTitusTech/winutil.git
synced 2025-07-03 19:53:50 -05:00
Added even more content to the docs
This commit is contained in:
BIN
docs/assets/CommitGHD.png
Normal file
BIN
docs/assets/CommitGHD.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 42 KiB |
BIN
docs/assets/CreateBranch.png
Normal file
BIN
docs/assets/CreateBranch.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 12 KiB |
BIN
docs/assets/Get-Installed.png
Normal file
BIN
docs/assets/Get-Installed.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 91 KiB |
BIN
docs/assets/Settings-Export.png
Normal file
BIN
docs/assets/Settings-Export.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 99 KiB |
@ -27,23 +27,16 @@
|
||||
* Fork the WinUtil Repository [here](https://github.com/ChrisTitusTech/winutil) to create a copy that will be available in your Repository-list.
|
||||

|
||||
|
||||
### Modify 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.
|
||||
#### GitHub Desktop
|
||||
* Using the application GitHub Desktop (available in WinUtil) you can easily manage your repos locally.
|
||||
1. Install GitHub Desktop if not already installed
|
||||
2. Log in using the same GitHub account u used to fork WinUtil
|
||||
3. Choose the fork under "Your Repositories" and press "clone {repo name}"
|
||||
* 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.
|
||||
|
||||
#### git
|
||||
1. Install Git (available in WinUtil) if not already installed.
|
||||
2. Open a terminal or command prompt.
|
||||
3. change the directory to where the fork should be cloned:
|
||||
4. Clone your forked repository using the following command:
|
||||
* git clone https://github.com/{your-username}/winutil.git
|
||||
5. you can now find
|
||||
|
||||
### Testing your changes
|
||||
* To test to see if your changes work as intended run following commands in a powershell teminal:
|
||||
@ -55,8 +48,8 @@
|
||||
* 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
|
||||
#### Github Desktop
|
||||
*
|
||||
* Commit your changes once you are fine with the result
|
||||
* Push the changes to "upload" them to your fork on github.com.
|
||||
|
||||
### 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.
|
||||
|
@ -1,4 +1,6 @@
|
||||
# Welcome to Chris Titus WinUtil Docs!
|
||||
# Welcome to Chris Titus WinUtil Offical Documentation!
|
||||
|
||||
[](https://discord.gg/RUbZUZyByQ)
|
||||
|
||||
## Running
|
||||
|
||||
|
@ -1,78 +1,97 @@
|
||||
# User Guide
|
||||
|
||||
## Overview
|
||||
* short one
|
||||
|
||||
## Program
|
||||
|
||||
### Installation & Updates
|
||||
## Walkthrough
|
||||
|
||||
### Program
|
||||
|
||||
#### Installation & Updates
|
||||
* To install programs select the programs you wish to install or update like the picture below.
|
||||

|
||||
* Once you have selected the programs you wish to install click the select Install/Upgrade Selected button as seen below.
|
||||

|
||||
|
||||
### Upgrade All
|
||||
#### Upgrade All
|
||||
* Press the button to upgrade all installed programs that are supported by WinGet, there is no selection needed.
|
||||
|
||||
### Uninstall
|
||||
#### Uninstall
|
||||
* To uninstall programs select the programs you wish to uninstall like the picture below.
|
||||

|
||||
* Once you have selected the programs you wish to uninstall click the select Uninstall Selected button as seen below.
|
||||

|
||||
|
||||
### Get Installed
|
||||
#### Get Installed
|
||||
* Checks for installed programs that are supported by WinGet and selects them in the Utility.
|
||||
|
||||
### Clear Selection
|
||||
#### Clear Selection
|
||||
* Clears ur current selection so no program is checked.
|
||||
|
||||
## Tweaks
|
||||
### Tweaks
|
||||
|
||||
### Tweaks Addition
|
||||
#### Tweaks Addition
|
||||
* 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.
|
||||

|
||||
* After you have chosen your tweaks click the Run Tweaks button at the bottom of the screen.
|
||||
|
||||
### Tweaks Removal
|
||||
#### Tweaks Removal
|
||||
* 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
|
||||
#### Essential Tweaks
|
||||
* The Tweaks under the Essential
|
||||
|
||||
### Advanced Tweaks - CAUTION
|
||||
#### Advanced Tweaks - CAUTION
|
||||
|
||||
### O&O Shutup
|
||||
#### O&O Shutup
|
||||
|
||||
### DNS
|
||||
#### DNS
|
||||
|
||||
### Customize Preferences
|
||||
#### Customize Preferences
|
||||
|
||||
### Performance Plans
|
||||
#### Performance Plans
|
||||
|
||||
### Shortcuts
|
||||
#### Shortcuts
|
||||
|
||||
|
||||

|
||||
|
||||
## Config
|
||||
### Config
|
||||
|
||||
### Features
|
||||
#### Features
|
||||
* Install the most used Windows Features by checking the checkbox and clicking "Install Features" to install them
|
||||
|
||||
### Fixes
|
||||
#### Fixes
|
||||
* Quick Fixes for your system if you are having Issues.
|
||||
|
||||
- Set Up Autologin
|
||||
- Reset Windows Update
|
||||
- Reset Network
|
||||
- System Corruption Scan
|
||||
- WinGet Reinstall
|
||||
- Remove Adobe Creative Cloud
|
||||
* Set Up Autologin
|
||||
* Reset Windows Update
|
||||
* Reset Network
|
||||
* System Corruption Scan
|
||||
* WinGet Reinstall
|
||||
* Remove Adobe Creative Cloud
|
||||
|
||||
### Legacy Windows Panels
|
||||
#### Legacy Windows Panels
|
||||
|
||||
## Updates | Not working rn
|
||||
### Updates | Not working rn
|
||||
|
||||
## MicroWin
|
||||
### MicroWin
|
||||
|
||||
## 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
|
||||
|
||||
* On the Install Tab, click "Get Installed", this will get all installed apps **supported by Winutil** on the system
|
||||

|
||||
* Click on the Settings cog in the upper right corner and chose Export, chose file file and location, this will export the setting file.
|
||||

|
||||
* Copy this file to a USB or somewhere you can use after Windows installation.
|
||||
* Use Microwin tab to create a custom Windows image.
|
||||
* Install the Windows image.
|
||||
* 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" ```
|
||||
* Have a cup of coffee! Come back when it's done.
|
@ -1,8 +1,12 @@
|
||||
{% extends "base.html" %}
|
||||
|
||||
{% block header %}
|
||||
{{ super() }}
|
||||
<div style="color: red; text-align: center; padding: 10px; font-size: 20px;">
|
||||
<strong>Announcement:</strong> This documentation is still in working progress.
|
||||
</div>
|
||||
{{ super() }}
|
||||
<div style="color: red; text-align: center; padding: 10px; font-size: 20px;">
|
||||
<strong>Announcement:</strong> This documentation is still in progress.
|
||||
</div>
|
||||
{% endblock %}
|
||||
|
||||
{% block footer %}
|
||||
{# Empty block to override the footer #}
|
||||
{% endblock %}
|
Reference in New Issue
Block a user