From 4375b7f8808177e6a2b94ec5c6270e3289a8575f Mon Sep 17 00:00:00 2001 From: zx Date: Wed, 11 Sep 2024 17:33:40 -0400 Subject: [PATCH] docs: update install instructions --- README.md | 32 +++++++++++++++++++++++--------- 1 file changed, 23 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 33763ee..05a805e 100644 --- a/README.md +++ b/README.md @@ -2,8 +2,6 @@ a rewrite of [pyzule](https://github.com/asdfzxcvbn/pyzule) that doesn't (completely) suck !! -cyan supports **linux, macOS, WSL, and jailbroken iOS!** all either x86_64 or arm64/aarch64 !! - ## features you can open an issue to request a feature :D !! @@ -22,17 +20,33 @@ you can open an issue to request a feature :D !! ## install instructions +cyan supports **linux, macOS, WSL, and jailbroken iOS!** all either x86_64 or arm64/aarch64 !! + first, make sure you have [ar](https://command-not-found.com/ar) and [tar](https://command-not-found.com/tar) installed -also obviously install python, version 3.9 or greater is required (the version available on the procursus repo for iOS) +also obviously install python, version 3.9 or greater is required -1. install [pipx](https://github.com/pypa/pipx?tab=readme-ov-file#install-pipx) -2. install cyan: `pipx install --force https://github.com/asdfzxcvbn/pyzule-rw/archive/main.zip` -3. follow any instructions `pipx` may have given you, like `pipx ensurepath` -4. **if you want to inject dylibs and ARE NOT ON iOS**: `pipx inject cyan lief` -5. **if you want to change app icons (iOS NOT supported)**: `pipx inject cyan Pillow` +
+linux/WSL/macOS instructions +
+
    +
  1. install pipx
  2. +
  3. install OR update cyan: pipx install --force https://github.com/asdfzxcvbn/pyzule-rw/archive/main.zip
  4. +
  5. add cyan to PATH: pipx ensurepath
  6. +
  7. if you want to inject dylibs and ARE NOT ON iOS: pipx inject cyan lief
  8. +
  9. if you want to change app icons (iOS NOT supported): pipx inject cyan Pillow
  10. +
+
-to *update*, just run step 2 again ! +
+jailbroken iOS instructions +
+
    +
  1. install OR update cyan: pip install --force-reinstall https://github.com/asdfzxcvbn/pyzule-rw/archive/main.zip
  2. +
+
+ +note: if you installed cyan before v1.1.3 using `pip`, make sure you `pip uninstall cyan`, then verify you have the latest version with `cyan --version` ## making cyan files