aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBryson Steck <steck.bryson@gmail.com>2022-06-05 01:01:10 -0600
committerBryson Steck <steck.bryson@gmail.com>2022-06-05 01:01:10 -0600
commit31ce95880323b404a5ab261ca4038ad2abc5c64e (patch)
tree83bbe13774c5948fec4b1247419c18d9b7c34946
parent16cc62686eb37a557b6f33f51da373406bfbc2c6 (diff)
downloadriibalanced-patcher-31ce95880323b404a5ab261ca4038ad2abc5c64e.tar
riibalanced-patcher-31ce95880323b404a5ab261ca4038ad2abc5c64e.tar.gz
riibalanced-patcher-31ce95880323b404a5ab261ca4038ad2abc5c64e.tar.bz2
add setup to readme
-rw-r--r--README.md13
-rw-r--r--SETUP.md16
2 files changed, 12 insertions, 17 deletions
diff --git a/README.md b/README.md
index 16b3820..f1877d4 100644
--- a/README.md
+++ b/README.md
@@ -6,20 +6,11 @@ A simple shell script that takes the Riibalanced Patch Files and builds a WBFS i
You need three things before starting:
-1. A computer system running:
- * Linux/BSD with `bash` installed
- * macOS
- * ~~Windows with [Cygwin](https://www.cygwin.com/)~~ (Not Implemented) or [WSL](https://docs.microsoft.com/en-us/windows/wsl/install)
+1. A computer system running Linux/BSD, macOS, or Windows.
2. A Mario Kart Wii image in ISO, WBFS, WDF, WIA, CISO, WBI, or GCZ format. (Obtained legally, of course)
3. The Riibalanced Patch Archive (This can be downloaded via the Riibalanced Discord Server)
-After that, clone the repository and run the script:
-```bash
-git clone https://github.com/brysonsteck/riibalanced-patcher.git
-cd riibalanced-patcher
-./patch_iso.sh
-```
-The script will guide you on what you need to do in order for the pather to work correctly.
+To get the script ready, you can follow my [setup guide](SETUP.md) (recommended for Windows users) or wing it. The script will guide you on what you need to do in order for the patcher to work correctly anyways.
## Current Issues with the Patcher
diff --git a/SETUP.md b/SETUP.md
index 3e19213..3ee62a8 100644
--- a/SETUP.md
+++ b/SETUP.md
@@ -1,18 +1,20 @@
# Setup the Patcher
-Click your OS below to jump to the section:
+When you run the patcher, it will make sure you have everything you need before you start, including making sure you have the Riibalanced patch files in the right location. But if you want to be on the safe side before beginning, you can follow this guide.
+
+Click your OS below to jump to their instructions:
* [Linux/BSD](#linuxbsd)
* [macOS](#macOS)
-There are two setup methods for Windows users. Choose one of the two options:
+Windows users can choose one of the two options below for setting up the script:
* [WSL](#windows---wsl) (**RECOMMENDED**, a little tricky to install but easy to remove)
* [Cygwin](#windows---cygwin) (More advanced, simple to install but difficult to remove)
## Linux/BSD
-No additional setup is required. Simply install `git`, `curl`, and `bash` (which is most likely installed) with your distro's package manager, then clone the repository and run the script:
+Simply install `git`, `curl`, and `bash` (which is most likely installed) with your distro's package manager, then clone the repository and run the script:
```bash
git clone https://github.com/brysonsteck/riibalanced-patcher.git
@@ -89,15 +91,15 @@ wsl --unregister Debian
## Windows - Cygwin
-These instructions are accurate as of setup version 2.918. **Use the [WSL guide](#windows---wsl) if you plan on uninstalling the software after using the patcher, as it is easier to uninstall.** **Do not follow these instructions if you have already installed a WSL distro..**
+These instructions are accurate as of setup version 2.918. **Use the [WSL guide](#windows---wsl) if you plan on uninstalling the software after using the patcher, as it is easier to uninstall.** **Do not follow these instructions if you have already installed a WSL distro.**
### Installing Cygwin
You can skip to [Running the patcher on Cygwin](#Running-the-patcher-on-Cygwin) if you already have Cygwin installed.
-To install Cygwin, you need to [download the installer]() from the Cygwin website. Upon downloading, run the program.
+To install Cygwin, you need to [download the installer]() from the Cygwin website. Upon downloading, run the program as Administrator.
-When it asks to choose a download source, choose "Install from Internet" and click next.
+When it asks to choose a download source, choose "Install from Internet" and click "Next".
You can change the install direcotry if you wish, including installing for all users or just yourself.
@@ -113,6 +115,8 @@ Once everything has downloaded, you can add shortcuts on the desktop or Start Me
### Running the patcher on Cygwin
+If you have installed Cygwin already (i.e. not by using my guide above), make sure that `git` and `curl` is installed.
+
Start Cygwin by using the shortcut(s) you made or by running the batch file where you installed it (probably `C:\cygwin64`), then you can clone the repository and run the script:
```bash