winutil/search/search_index.json

1 line
428 KiB
JSON
Raw Normal View History

{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"Welcome to the WinUtil Documentation!","text":"<p>Welcome to the official documentation for WinUtil, your go-to utility for optimizing and managing your Windows environment. Whether you\u2019re an IT professional, power user, or regular user, WinUtil provides a comprehensive set of tools to enhance your Windows experience.</p>"},{"location":"#running-the-latest-release-of-winutil","title":"Running the latest release of WinUtil","text":"<ul> <li>You will first need to start a Powershell terminal as Admin.</li> <li>Now you can run the following command: <pre><code>irm christitus.com/win | iex\n</code></pre></li> </ul> <p>Info</p> <p>WinUtil is updated weekly as of the time of writing. Consequently, features and functionalities may evolve, and the documentation may not always reflect the most current images or information.</p>"},{"location":"CONTRIBUTING/","title":"How to Contribute?","text":""},{"location":"CONTRIBUTING/#testing","title":"Testing","text":"<ul> <li>Test the latest changes to WinUtil by running the pre-release and reporting issues you are encountering to help us continually improve WinUtil!</li> </ul>"},{"location":"CONTRIBUTING/#run-the-latest-pre-release","title":"Run the latest pre-release","text":"<pre><code>irm christitus.com/windev | iex\n</code></pre> <p>Keep in mind</p> <p>This is a pre-release and should be treated as such. It exists for developers to test the utility and report or fix bugs before they get added to the stable release. Don't use it in production!</p>"},{"location":"CONTRIBUTING/#issues","title":"Issues","text":"<ul> <li>If you encounter any challenges or problems with the script, I kindly request that you submit them via the \"Issues\" tab on the GitHub repository. By filling out the provided template, you can provide specific details about the issue, allowing me (and others in the community) to promptly address any bugs or consider feature requests.</li> </ul>"},{"location":"CONTRIBUTING/#contribute-code","title":"Contribute Code","text":"<ul> <li> <p>Pull requests are now handled directly on the MAIN branch. This was done since we can now select specific releases to launch via releases in GitHub.</p> </li> <li> <p>If you're doing code changes, then you can submit a PR to <code>main</code> branch, but I am very selective about these.</p> </li> </ul> <p>Important</p> <p>Do not use a code formatter, make massive amounts of line changes, or make multiple feature changes. EACH FEATURE CHANGE SHOULD BE IT'S OWN PULL REQUEST!</p> <ul> <li> <p>When creating pull requests, it is essential to thoroughly document all changes made. This includes, but is not limited to, documenting any additions made to the <code>tweaks</code> section and corresponding <code>undo tweak</code>, so users are able to remove the newly added tweaks if necessary, and comprehensive documentation is required for all code changes. Document your changes and briefly explain why you made your changes in your Pull Request Description. Failure to adhere to this format may result in the denial of the pull request. Additionally, any code lacking sufficient documentation may also be denied.</p> </li> <li> <p>By following these guidelines, we can maintain a high standard of quality and ensure that the codebase remains organized and well-documented.</p> </li> </ul> <p>Note</p> <p>When creating a function, please include \"WPF\" or \"WinUtil\" in the file name so it can be loaded into the runspace.</p>"},{"location":"CONTRIBUTING/#walk-through","title":"Walk through","text":"<ul> <li>This is a guide for beginners. If you are still having issues, look at the following official GitHub documentation:<ul> <li>Commit through WEB</li> <li>Commit through GitHub Desktop</li> <li>Create a Pull Request</li> </ul> </li> </ul>"},{"location":"CONTRIBUTING/#overview","title":"Overview","text":"<pre><code>%%{init: {\"flowchart\": {\"curve\": \"cardinal\"}} }%%\ngraph TD\n\u00a0 A[Fork Project] --&gt; B[Clone Repository];\n\u00a0 B