xstefen/winutil
1
0
Fork 0
mirror of https://github.com/ChrisTitusTech/winutil.git synced 2025-06-28 00:54:47 -05:00
Code Issues Packages Projects Releases Wiki Activity

[DOCS] remove docs folder - add build instructions (#3387)

Browse Source 
* Move 'CONTRIBUTING.md' file from 'docs' folder to '.github' folder

More info: https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors#about-contributing-guidelines

* Remove 'docs' Folder as it became obsolete

The contents of this folder have been moved to the Docs Repo (link: https://github.com/Chris-Titus-Docs/winutil-docs) and slightly modified to work nicely with the Web Technology used, which's Hugo the Static Site Generator written in Go Programming Language

* Add Build Instructions in 'README.md'

* Add note to redirect new users to the Docs Repo

* Link the main image of README from docs repo

Thanks @NotYourAverageGamer !
This commit is contained in:
Mr.k
2025-06-19 00:22:43 +03:00
committed by GitHub
parent 4be99d5f8a
commit 00c295e8d5
113 changed files with 27 additions and 12724 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
README.md
View File

@ -7,7 +7,7 @@
This utility is a compilation of Windows tasks I perform on each Windows system I use. It is meant to streamline *installs*, debloat with *tweaks*, troubleshoot with *config*, and fix Windows *updates*. I am extremely picky about any contributions to keep this project clean and efficient.
![screen-install](./docs/assets/Title-Screen.png)
![screen-install](https://raw.githubusercontent.com/Chris-Titus-Docs/winutil-docs/refs/heads/main/assets/images/Title-Screen.png)
## 💡 Usage
@ -39,12 +39,38 @@ If you have Issues, refer to [Known Issues](https://winutil.christitus.com/known
## 🎓 Documentation
> [!NOTE]
> To contribute to the documentation, please visit [WinUtil Docs Repo](https://github.com/Chris-Titus-Docs/winutil-docs) for more info.
### [WinUtil Official Documentation](https://winutil.christitus.com/)
### [YouTube Tutorial](https://www.youtube.com/watch?v=6UQZ5oQg8XA)
### [ChrisTitus.com Article](https://christitus.com/windows-tool/)
## 🛠️ Build & Develop
> [!NOTE]
> Winutil is a relatively large script, so it's split into multiple files which're combined into a single `.ps1` file using a custom compiler. This makes maintaining the project a lot easiler.
Get a copy of the source code, this can be done using GitHub UI (`Code -> Download ZIP`), or by cloning (downloading) the repo using git.
If git is installed, run the following commands under a PowerShell window to clone and move into project's directory:
```ps1
git clone --depth 1 "https://github.com/ChrisTitusTech/winutil.git"
cd winutil
```
To build the project, run the Compile Script under a PowerShell window (admin permissions IS NOT required):
```ps1
.\Compile.ps1
```
You'll see a new file named `winutil.ps1`, which's created by `Compile.ps1` script, now you can run it as admin and a new window will popup, enjoy your own compiled version of WinUtil :)
> [!TIP]
> For more info on using WinUtil and how to develop for it, please consider reading [the Contribution Guidelines](https://winutil.christitus.com/contributing/), if you don't know where to start, or have questions, you can ask over on our [Discord Community Server](https://discord.gg/RUbZUZyByQ) and active project members will answer when they can.
## 💖 Support
- To morally and mentally support the project, make sure to leave a ⭐️!
- EXE Wrapper for $10 @ https://www.cttstore.com/windows-toolbox