stephen/StikDebug
1
0
Fork 0
mirror of https://github.com/StikDebug/StikDebug.git synced 2026-10-15 20:10:30 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Update README.md

Browse source
This commit is contained in:
Stephen B 2025-06-01 23:45:19 -04:00 • committed by GitHub
parent a33ef443f4
commit 649b4223f5
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 3 additions and 42 deletions
Download patch file Download diff file Expand all files Collapse all files

45
README.md
View file

@ -33,49 +33,10 @@
</h6>
## Features
- On-device Just-In-Time (JIT) compilation for supported apps via [`idevice`](https://github.com/jkcoxson/idevice).
- Seamless integration with [`em_proxy`](https://github.com/SideStore/em_proxy).
- Native UI for managing JIT-enabling.
- On-device debugging/Just-In-Time (JIT) compilation for supported apps via [`idevice`](https://github.com/jkcoxson/idevice).
- Seamless integration with our custom built loopback vpn.
- Native UI for managing debugging/JIT-enabling.
- No data collection—ensuring full privacy.
## Building Instructions
1. **Clone the repository:**
```sh
git clone https://github.com/0-Blu/StikJIT.git
cd StikJIT
```
2. **Build using Makefile:**
```sh
make package # Build unsigned .ipa
```
3. **Updating:**
```sh
git pull
make clean # Clean previous build
make package # Rebuild
```
> [!WARNING]
> The __Makefile__ build creates an unsigned .ipa in the `packages` directory. While this is useful for quick builds, please use Xcode for development and debugging. When submitting pull requests or reporting issues, ensure you've tested your changes thoroughly using Xcode.
## Contributing
```sh
# Clone the repository
git clone https://github.com/0-Blu/StikJIT.git
cd StikJIT
# Open in Xcode
open StikJIT.xcodeproj
```
Then in Xcode:
- Connect your iOS device
- Select your device in Xcode
- Build and run the project (⌘R)
## License
StikDebug is licensed under **AGPL-3.0**. See [`LICENSE`](LICENSE) for details.