From df6d2233651b0a4cfbcecd3473fc91a02bf90f71 Mon Sep 17 00:00:00 2001 From: Stephen <158498287+0-Blu@users.noreply.github.com> Date: Fri, 28 Mar 2025 10:59:19 -0400 Subject: [PATCH 1/4] Update README.md --- README.md | 45 +++++++++++++++++++++++++++++++++------------ 1 file changed, 33 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 360119e..fd63b96 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,45 @@ -# StikJIT +# StikJIT -A **work-in-progress** on-device JIT enabler. +A **work-in-progress** on-device JIT enabler for iOS. -The [SideStore VPN](https://github.com/SideStore/SideStore/releases/download/0.1.1/SideStore.conf) is required. This allows the device to connect to itself. +## Requirements +The [SideStore VPN](https://github.com/SideStore/SideStore/releases/download/0.1.1/SideStore.conf) is required. This allows the device to connect to itself. -Powered by [idevice](https://github.com/jkcoxson/idevice) and [Emotional Mangling Proxy](https://github.com/SideStore/em_proxy). +## Features +- On-device Just-In-Time (JIT) compilation for supported apps. +- Seamless integration with `em_proxy` and `idevice`. +- Native UI for managing JIT-enabling. +- No data collection—ensuring full privacy. -All dependencies remain under their original licenses. +## Privacy Policy +StikJIT **does not collect or store any user data.** -## Privacy Policy -No data is collected +## Compiling Instructions + +1. **Clone the repository:** + ```sh + git clone https://github.com/0-Blu/StikJIT.git + cd StikJIT + ``` + +2. **Open in Xcode:** + Open `StikJIT.xcodeproj` in Xcode. + +3. **Build and Run:** + - Connect your iOS device. + - Select your device in Xcode. + - Build and run the project. ## TODO List - - [X] Integrate `em_proxy` -- [X] Compile idevice -- [X] Implement heartbeat -- [ ] Mount the developer image +- [X] Compile `idevice` +- [X] Implement heartbeat +- [ ] Mount the developer image - [X] Retrieve and filter installed apps by `get-task-allow` - [X] Enable JIT for selected apps -- [X] Design and implement a user-friendly UI (Done for now) +- [X] Design and implement a user-friendly UI *(Done for now)* - [ ] Write comprehensive documentation - [ ] Prepare and release the initial version + +## License +StikJIT is licensed under **AGPL-3.0**. See [`LICENSE`](LICENSE) for details. From a3be44be3404b56927d4d69cc4bf85b54747b89a Mon Sep 17 00:00:00 2001 From: Stephen <158498287+0-Blu@users.noreply.github.com> Date: Fri, 28 Mar 2025 11:01:28 -0400 Subject: [PATCH 2/4] Update README.md --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index fd63b96..a31473c 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ The [SideStore VPN](https://github.com/SideStore/SideStore/releases/download/0.1 ## Features - On-device Just-In-Time (JIT) compilation for supported apps. -- Seamless integration with `em_proxy` and `idevice`. +- Seamless integration with [`em_proxy`](https://github.com/SideStore/em_proxy) and [`idevice`](https://github.com/jkcoxson/idevice). - Native UI for managing JIT-enabling. - No data collection—ensuring full privacy. @@ -18,7 +18,7 @@ StikJIT **does not collect or store any user data.** 1. **Clone the repository:** ```sh - git clone https://github.com/0-Blu/StikJIT.git + git clone https://github.com/your-username/StikJIT.git cd StikJIT ``` @@ -31,8 +31,8 @@ StikJIT **does not collect or store any user data.** - Build and run the project. ## TODO List -- [X] Integrate `em_proxy` -- [X] Compile `idevice` +- [X] Integrate [`em_proxy`](https://github.com/SideStore/em_proxy) +- [X] Compile [`idevice`](https://github.com/jkcoxson/idevice) - [X] Implement heartbeat - [ ] Mount the developer image - [X] Retrieve and filter installed apps by `get-task-allow` From 44c054adf8de2fd7428e74ba1fdd646c633e1ee5 Mon Sep 17 00:00:00 2001 From: neoarz Date: Fri, 28 Mar 2025 11:21:40 -0400 Subject: [PATCH 3/4] fork then clone --- README.md | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index a31473c..5cd8b46 100644 --- a/README.md +++ b/README.md @@ -16,16 +16,20 @@ StikJIT **does not collect or store any user data.** ## Compiling Instructions -1. **Clone the repository:** +1. **Fork the repository:** + - Visit the [StikJIT repository](https://github.com/0-Blu/StikJIT.git) + - Click the "Fork" button in the top-right corner to create your own copy + +2. **Clone your forked repository:** ```sh - git clone https://github.com/your-username/StikJIT.git + git clone https://github.com/your-github-username/StikJIT.git cd StikJIT ``` -2. **Open in Xcode:** +3. **Open in Xcode:** Open `StikJIT.xcodeproj` in Xcode. -3. **Build and Run:** +4. **Build and Run:** - Connect your iOS device. - Select your device in Xcode. - Build and run the project. From 3c501da79c3f448797716e9664ba8b1c384df41a Mon Sep 17 00:00:00 2001 From: neoarz Date: Fri, 28 Mar 2025 11:25:36 -0400 Subject: [PATCH 4/4] readme --- README.md | 12 ++++-------- 1 file changed, 4 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 5cd8b46..da13e86 100644 --- a/README.md +++ b/README.md @@ -16,20 +16,16 @@ StikJIT **does not collect or store any user data.** ## Compiling Instructions -1. **Fork the repository:** - - Visit the [StikJIT repository](https://github.com/0-Blu/StikJIT.git) - - Click the "Fork" button in the top-right corner to create your own copy - -2. **Clone your forked repository:** +1. **Clone the repository:** ```sh - git clone https://github.com/your-github-username/StikJIT.git + git clone https://github.com/0-Blu/StikJIT.git cd StikJIT ``` -3. **Open in Xcode:** +2. **Open in Xcode:** Open `StikJIT.xcodeproj` in Xcode. -4. **Build and Run:** +3. **Build and Run:** - Connect your iOS device. - Select your device in Xcode. - Build and run the project.