docs changes

ydoow · Sep 1, 2022 · da48ac5 · da48ac5
1 parent 2247023
commit da48ac5
Show file tree

Hide file tree

Showing 5 changed files with 72 additions and 23 deletions.
diff --git a/docs/usage/run-in-docker.md b/docs/usage/run-in-docker.md
@@ -31,4 +31,3 @@ description: Run Permasigner in the official Docker container.
     * The script can do that for you, you will be asked to input the user password for ssh access.
     * Airdropping the file is probably the easiest, but you can use something like Dropbox or Mega. Advanced users can use openssh-sftp-server from Procursus.
 * Reboot to stock, the app will still work!
-
diff --git a/docs/usage/run-on-ios.md b/docs/usage/run-on-ios.md
@@ -10,10 +10,19 @@ If asked, the default root password is `alpine`.
 
 * Install NewTerm 2 from [Chariz](https://repo.chariz.com) using your favorite package manager
 * Install permasigner with `python3 -m pip install permasigner`
-   * If this fails, install python3 with `su root -c apt install python3` and install pip with `python3 -m ensurepip`.
+    * If this fails, install python3 with `su root -c apt install python3` and install pip with `python3 -m ensurepip`.
+
+{% hint style="info" %}
+If you have extra entitlements, append the `-e` flag when running the script. If you don't know what this means, you can ignore this.
+
+When running the script, you will notice the a `one of the arguments is required` error. You'll need to append the IPA to sign as an argument, like `-u https://example.com/app.ipa`, or `-p /Users/nebula/Downloads/app.ipa`, for example.
+
+You may also pass the `-i` argument to install the created deb file automagically :)
+{% endhint %}
+
 * Run the script with `python3 -m permasigner`
 * Install the newly created deb file
-   * Find it in Filza at `/var/mobile/.permasigner/output`
+    * Find it in Filza at `/var/mobile/.permasigner/output`
 * Reboot to stock, the app will still work!
 
 ## Run with Shortcut
@@ -23,25 +32,29 @@ This will only work on Procursus jailbreaks for now.
 {% endhint %}
 
 * Import the shortcut from [here](https://routinehub.co/shortcut/12520/)
-   * Make sure to pay attention to the import questions.
+    * Make sure to pay attention to the import questions.
 * Run the shortcut
-   * It may seem like it's frozen in some parts, but it isn't.
+    * It may seem like it's frozen in some parts, but it isn't.
 * Choose one of the options and follow the prompts
 * The app will install if you choose!
-   * If you choose not to, it's in /var/mobile/.permasigner/src/output.
+    * If you choose not to, it's in /var/mobile/.permasigner/src/output.
 
 ## Run from Source
 
 * Install NewTerm 2 from [Chariz](https://repo.chariz.com) using your favorite package manager
 * Clone this repository with `git clone https://github.com/permasigner/permasigner && cd permasigner`
-   * If this fails, install git with `su root -c apt install git`.
-* Run the script with `python3 -m permasigner`
-   * If this fails, install python3 with `su root -c apt install python3` and pip with `python3 -m ensurepip`.
+    * If this fails, install git with `su root -c apt install git`.
 
 {% hint style="info" %}
 If you have extra entitlements, append the `-e` flag when running the script. If you don't know what this means, you can ignore this.
+
+When running the script, you will notice the a `one of the arguments is required` error. You'll need to append the IPA to sign as an argument, like `-u https://example.com/app.ipa`, or `-p /Users/nebula/Downloads/app.ipa`, for example.
+
+You may also pass the `-i` argument to install the created deb file automagically :)
 {% endhint %}
 
+* Run the script with `python3 -m permasigner`
+    * If this fails, install python3 with `su root -c apt install python3` and pip with `python3 -m ensurepip`.
 * Install the newly created deb file
-   * You can use something like Filza to find it, it's in /var/mobile/permasigner/output.
+    * You can use something like Filza to find it, it's in /var/mobile/permasigner/output.
 * Reboot to stock, the app will still work!
diff --git a/docs/usage/run-on-linux.md b/docs/usage/run-on-linux.md
@@ -7,25 +7,38 @@ description: Run Permasigner on Debian based Linux distros.
 * Open a terminal using Ctrl + Shift + T on most Linux distros
 * Install bzip2 and binutils using your package manager of choice; ex. `sudo apt install bzip2 binutils`
 * Install the package with `pip install permasigner` or `pip3 install permasigner`
-   * If this fails, install python3 with your package manager of choice; ex. `sudo apt install python3`.
+    * If this fails, install python3 with your package manager of choice; ex. `sudo apt install python3`.
+
+{% hint style="info" %}
+If you have extra entitlements, append the `-e` flag when running the script. If you don't know what this means, you can ignore this.
+
+When running the script, you will notice the a `one of the arguments is required` error. You'll need to append the IPA to sign as an argument, like `-u https://example.com/app.ipa`, or `-p /Users/nebula/Downloads/app.ipa`, for example.
+
+You may also pass the `-i` argument to install the created deb on your connected device file automagically :)
+{% endhint %}
+
 * Run the script with `python -m permasigner` or `python3 -m permasigner`
 * Install the newly created deb file on your iDevice
-   * You can use something like Dropbox or Mega; advanced users can use `openssh-sftp-server` from Procursus.
+    * You can use something like Dropbox or Mega; advanced users can use `openssh-sftp-server` from Procursus.
 * Reboot to stock, the app will still work!
 
 ## Run from Source
 
 * Open a terminal using Ctrl + Shift + T on most Linux distros
 * Install bzip2 and binutils using your package manager of choice; ex. `sudo apt install bzip2 binutils`
 * Clone this repository with `git clone https://github.com/permasigner/permasigner && cd permasigner`
-   * If this fails, install git with your package manager of choice; ex. `sudo apt install git`.
-* Run the script with `python -m permasigner` or `python3 -m permasigner`
-   * If this fails, install python3 with your package manager of choice; ex. `sudo apt install python3`.
+    * If this fails, install git with your package manager of choice; ex. `sudo apt install git`.
 
 {% hint style="info" %}
 If you have extra entitlements, append the `-e` flag when running the script. If you don't know what this means, you can ignore this.
+
+When running the script, you will notice the a `one of the arguments is required` error. You'll need to append the IPA to sign as an argument, like `-u https://example.com/app.ipa`, or `-p /Users/nebula/Downloads/app.ipa`, for example.
+
+You may also pass the `-i` argument to install the created deb on your connected device file automagically :)
 {% endhint %}
 
+* Run the script with `python -m permasigner` or `python3 -m permasigner`
+    * If this fails, install python3 with your package manager of choice; ex. `sudo apt install python3`.
 * Install the newly created deb file on your iDevice
     * You can use something like Dropbox or Mega; advanced users can use `openssh-sftp-server` from Procursus.
 * Reboot to stock, the app will still work!
diff --git a/docs/usage/run-on-macos.md b/docs/usage/run-on-macos.md
@@ -8,27 +8,38 @@ description: Run Permasigner on macOS.
    * If you use a third-party terminal, it'll most likely work too.
 * Install dpkg using [brew](https://brew.sh) with `brew install dpkg`
 * Install all requirements with `pip install permasigner` or `pip3 install permasigner`
-   * If this fails, install python3 using brew with `brew install python3`.
+    * If this fails, install python3 using brew with `brew install python3`.
+
+{% hint style="info" %}
+If you have extra entitlements, append the `-e` flag when running the script. If you don't know what this means, you can ignore this.
+
+When running the script, you will notice the a `one of the arguments is required` error. You'll need to append the IPA to sign as an argument, like `-u https://example.com/app.ipa`, or `-p /Users/nebula/Downloads/app.ipa`, for example.
+
+You may also pass the `-i` argument to install the created deb on your connected device file automagically :)
+{% endhint %}
+
 * Run the script with `python -m permasigner` or `python3 -m permasigner`
 * Install the newly created deb file on your iDevice
-   * Airdropping the file is probably the easiest.
+    * Airdropping the file is probably the easiest.
 * Reboot to stock, the app will still work!
 
 ## Run from Source
 
 * Open Terminal from the Utilities folder or spotlight.
-   * If you use a third-party terminal, it'll most likely work too.
+    * If you use a third-party terminal, it'll most likely work too.
 * Clone this repository with `git clone https://github.com/permasigner/permasigner && cd permasigner`
-   * If this fails, install git with Xcode dev tools on macOS.
+    * If this fails, install git with Xcode dev tools on macOS.
 * Install dpkg using [brew](https://brew.sh) with `brew install dpkg`
-* Run the script with `python -m permasigner` or `python3 -m permasigner`
-   * If this fails, install python3 using brew with `brew install python3`.
 
 {% hint style="info" %}
 If you have extra entitlements, append the `-e` flag when running the script. If you don't know what this means, you can ignore this.
+
+When running the script, you will notice the a `one of the arguments is required` error. You'll need to append the IPA to sign as an argument, like `-u https://example.com/app.ipa`, or `-p /Users/nebula/Downloads/app.ipa`, for example.
+
+You may also pass the `-i` argument to install the created deb on your connected device file automagically :)
 {% endhint %}
 
 * Run the script with `python main.py` or `python3 main.py`
 * Install the newly created deb file on your iDevice
-   * Airdropping the file is probably the easiest.
+    * Airdropping the file is probably the easiest.
 * Reboot to stock, the app will still work!
diff --git a/docs/usage/run-on-windows.md b/docs/usage/run-on-windows.md
@@ -1,12 +1,21 @@
 ---
-description: Run Permasigner on Windows using WSL or Docker.
+description: Run Permasigner on Windows natively, with WSL, or with Docker.
 ---
 
 ## Run from Package (Recommended)
 
 * Open a Powershell window from the start menu
 * Install the package with `python -m pip install permasigner`
     * If this fails, install the latest Python 3 version from [here](https://python.org).
+
+{% hint style="info" %}
+If you have extra entitlements, append the `-e` flag when running the script. If you don't know what this means, you can ignore this.
+
+When running the script, you will notice the a `one of the arguments is required` error. You'll need to append the IPA to sign as an argument, like `-u https://example.com/app.ipa`, or `-p /Users/nebula/Downloads/app.ipa`, for example.
+
+You may also pass the `-i` argument to install the created deb on your connected device file automagically :)
+{% endhint %}
+
 * Run the script with `python -m permasigner`
 * Install the newly created deb file on your iDevice
     * You can use something like Dropbox or Mega; advanced users can use `openssh-sftp-server` from Procursus.
@@ -20,6 +29,10 @@ description: Run Permasigner on Windows using WSL or Docker.
 
 {% hint style="info" %}
 If you have extra entitlements, append the `-e` flag when running the script. If you don't know what this means, you can ignore this.
+
+When running the script, you will notice the a `one of the arguments is required` error. You'll need to append the IPA to sign as an argument, like `-u https://example.com/app.ipa`, or `-p /Users/nebula/Downloads/app.ipa`, for example.
+
+You may also pass the `-i` argument to install the created deb on your connected device file automagically :)
 {% endhint %}
 
 * Run the script with `python -m permasigner`
Original file line number	Diff line number	Diff line change
Expand Up		@@ -31,4 +31,3 @@ description: Run Permasigner in the official Docker container.
		* The script can do that for you, you will be asked to input the user password for ssh access.
		* Airdropping the file is probably the easiest, but you can use something like Dropbox or Mega. Advanced users can use openssh-sftp-server from Procursus.
		* Reboot to stock, the app will still work!