Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Kkthnx authored Mar 14, 2023
1 parent 90462e3 commit 41f3537
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,4 @@
<div class="relative flex w-[calc(100%-50px)] flex-col gap-1 md:gap-3 lg:w-[calc(100%-115px)]"><div class="flex flex-grow flex-col gap-3"><div class="min-h-[20px] flex flex-col items-start gap-4 whitespace-pre-wrap"><div class="markdown prose w-full break-words dark:prose-invert light"><hr><h1>KkthnxUI Installer for World of Warcraft</h1><p>This PowerShell script automates the process of downloading and installing the <strong>KkthnxUI addon</strong> for <em>World of Warcraft</em>. KkthnxUI is a user interface (UI) replacement addon that enhances the default World of Warcraft UI. The script downloads the latest version of the addon from its GitHub repository, extracts the contents, and installs it into the user-selected addons folder for World of Warcraft.</p><h2>How the script works:</h2><ol><li>Defines the parameters for the download URL and the output file name.</li><li>Loads the <code>System.Windows.Forms</code> assembly to use the <code>FolderBrowserDialog</code> later.</li><li>Displays a welcome banner.</li><li>Downloads the latest KkthnxUI version (master.zip) from GitHub.</li><li>Extracts the contents of the downloaded zip file to a temporary folder.</li><li>Prompts the user to select the World of Warcraft addons folder using a folder browser dialog.</li><li>Copies the extracted KkthnxUI folder to the selected addons folder.</li><li>Cleans up by deleting the downloaded zip file and temporary folders.</li></ol><h2>Steps to download and run the script:</h2><ol><li>Open a text editor and paste the provided PowerShell script.</li><li>Save the file with a ".ps1" extension, for example, "KkthnxUI_Installer.ps1".</li><li>Right-click the saved script file and click on "Run with PowerShell" to execute the script.</li><li>Follow the prompts in the PowerShell window to complete the installation.</li></ol><blockquote><p><strong>Note</strong>: You may need to allow script execution on your system if you haven't done so before. To do this, open PowerShell as an administrator and execute the following command:</p><pre><div class="bg-black mb-4 rounded-md"><div class="flex items-center relative text-gray-200 bg-gray-800 px-4 py-2 text-xs font-sans"><span class=""></span></div><div class="p-4 overflow-y-auto"><code class="!whitespace-pre hljs language-powershell">Set-ExecutionPolicy RemoteSigned
</code></div></div></pre><p>This will allow you to run locally created scripts while still requiring a digital signature for scripts downloaded from the internet.</p></blockquote><hr></div></div></div><div class="flex justify-between"><div class="text-gray-400 flex self-end lg:self-center justify-center mt-2 gap-3 md:gap-4 lg:gap-1 lg:absolute lg:top-0 lg:translate-x-full lg:right-0 lg:mt-0 lg:pl-2 visible"><button class="p-1 rounded-md hover:bg-gray-100 hover:text-gray-700 dark:text-gray-400 dark:hover:bg-gray-700 dark:hover:text-gray-200 disabled:dark:hover:text-gray-400"><svg stroke="currentColor" fill="none" stroke-width="2" viewBox="0 0 24 24" stroke-linecap="round" stroke-linejoin="round" class="h-4 w-4" height="1em" width="1em" xmlns="http://www.w3.org/2000/svg"><path d="M14 9V5a3 3 0 0 0-3-3l-4 9v11h11.28a2 2 0 0 0 2-1.7l1.38-9a2 2 0 0 0-2-2.3zM7 22H4a2 2 0 0 1-2-2v-7a2 2 0 0 1 2-2h3"></path></svg></button><button class="p-1 rounded-md hover:bg-gray-100 hover:text-gray-700 dark:text-gray-400 dark:hover:bg-gray-700 dark:hover:text-gray-200 disabled:dark:hover:text-gray-400"><svg stroke="currentColor" fill="none" stroke-width="2" viewBox="0 0 24 24" stroke-linecap="round" stroke-linejoin="round" class="h-4 w-4" height="1em" width="1em" xmlns="http://www.w3.org/2000/svg"><path d="M10 15v4a3 3 0 0 0 3 3l4-9V2H5.72a2 2 0 0 0-2 1.7l-1.38 9a2 2 0 0 0 2 2.3zm7-13h2.67A2.31 2.31 0 0 1 22 4v7a2.31 2.31 0 0 1-2.33 2H17"></path></svg></button></div></div></div>

<div class="markdown prose w-full break-words dark:prose-invert light"><hr><h2>KkthnxUI Installer Executable (EXE)</h2><p>As an alternative to running the PowerShell script, we also provide the KkthnxUI Installer as an executable (EXE) file. This option simplifies the installation process and requires fewer steps.</p><h3>Running the KkthnxUI Installer EXE:</h3><ol><li>Download the "KkthnxUI_Installer.exe" file from the repository.</li><li>Double-click the "KkthnxUI_Installer.exe" file to run the installer.</li></ol><blockquote><p><strong>Note</strong>: You do not need to run the executable as an administrator unless you encounter issues during the installation process.</p></blockquote><h3>Windows SmartScreen Warning:</h3><p>When running the executable, you may encounter a Windows SmartScreen warning, indicating that Windows is protecting your PC. This warning is displayed because the EXE file is not digitally signed. You can safely ignore this warning and proceed with the installation.</p><p>To bypass the warning:</p><ol><li>Click on "More info" in the warning dialog.</li><li>Click the "Run anyway" button.</li></ol><p>The KkthnxUI Installer will then proceed with the installation process.</p><hr></div>

0 comments on commit 41f3537

Please sign in to comment.