From 96e50714f285e1cca34cbf5cb4dfa6f26fd9d546 Mon Sep 17 00:00:00 2001 From: neoarz Date: Tue, 15 Apr 2025 16:04:57 -0400 Subject: [PATCH] update readme to use makefile --- README.md | 35 ++++++++++++++++++++++++++++------- 1 file changed, 28 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 21afbad..71c6aed 100644 --- a/README.md +++ b/README.md @@ -42,7 +42,7 @@ - Native UI for managing JIT-enabling. - No data collection—ensuring full privacy. -## Compiling Instructions +## Building Instructions 1. **Clone the repository:** ```sh @@ -50,13 +50,34 @@ cd StikJIT ``` -2. **Open in Xcode:** - Open `StikJIT.xcodeproj` in Xcode. +2. **Build using Makefile:** + ```sh + make package # Build unsigned .ipa + ``` -3. **Build and Run:** - - Connect your iOS device. - - Select your device in Xcode. - - Build and run the project. +3. **Updating:** + ```sh + git pull + make clean # Clean previous build + make package # Rebuild + ``` + +> **Note:** 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 StikJIT is licensed under **AGPL-3.0**. See [`LICENSE`](LICENSE) for details.