From 1b456784eb78315f43a0a9f206a8cece32658679 Mon Sep 17 00:00:00 2001 From: neoarz Date: Tue, 15 Apr 2025 22:22:57 -0400 Subject: [PATCH 1/4] update readme a bit more --- README.md | 43 ++++++++++++++++++++++++++++++------------- 1 file changed, 30 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 3f8f53be..4651c99e 100644 --- a/README.md +++ b/README.md @@ -67,19 +67,36 @@ ## 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) + + +1. **Set up your development environment:** + ```sh + # Clone the repository + git clone https://github.com/0-Blu/StikJIT.git + cd StikJIT + + # Open in Xcode + open StikJIT.xcodeproj + ``` + +2. **Make your changes:** + - Connect your iOS device + - Select your device in Xcode + - Build and run the project (⌘R) + - Make and test your changes thoroughly + +3. **Submit your contribution:** + - Fork the repository + - Create a new branch for your feature/fix + - Commit your changes with clear commit messages + - Push to your fork + - Open a pull request with a detailed description of your changes + +> **Tip:** Before submitting a pull request, ensure you've: +> - Tested your changes on a real device +> - Followed the existing code style +> - Added comments for complex logic +> - Updated documentation if needed ## License StikJIT is licensed under **AGPL-3.0**. See [`LICENSE`](LICENSE) for details. From c9b071b505400e2feba6ddcc5c6d1dded40dc07e Mon Sep 17 00:00:00 2001 From: neo <164915254+neoarz@users.noreply.github.com> Date: Tue, 15 Apr 2025 22:25:33 -0400 Subject: [PATCH 2/4] Update README.md --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 4651c99e..b9666ebe 100644 --- a/README.md +++ b/README.md @@ -91,8 +91,9 @@ - Commit your changes with clear commit messages - Push to your fork - Open a pull request with a detailed description of your changes - -> **Tip:** Before submitting a pull request, ensure you've: + +> [!TIP] +> Before submitting a pull request, ensure you've: > - Tested your changes on a real device > - Followed the existing code style > - Added comments for complex logic From ae11a05a040cfb90af7700eb6a34086c38b2e044 Mon Sep 17 00:00:00 2001 From: neoarz Date: Wed, 16 Apr 2025 09:56:35 -0400 Subject: [PATCH 3/4] link guide --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index b9666ebe..822736e2 100644 --- a/README.md +++ b/README.md @@ -42,7 +42,10 @@ - Native UI for managing JIT-enabling. - No data collection—ensuring full privacy. -## Building Instructions +## Installation Guide +For detailed installation instructions, including setup with SideStore, AltStore, or without any store, please refer to our [User Manual](user-manual.md). + +## Building 1. **Clone the repository:** ```sh From f911be1f781ad880c56c50fd48b8a9bf2408318a Mon Sep 17 00:00:00 2001 From: neo <164915254+neoarz@users.noreply.github.com> Date: Wed, 16 Apr 2025 09:58:59 -0400 Subject: [PATCH 4/4] Update README.md --- README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/README.md b/README.md index 822736e2..b20c5287 100644 --- a/README.md +++ b/README.md @@ -99,8 +99,7 @@ For detailed installation instructions, including setup with SideStore, AltStore > Before submitting a pull request, ensure you've: > - Tested your changes on a real device > - Followed the existing code style -> - Added comments for complex logic -> - Updated documentation if needed +> - Added comments explaning what your pull request is meant to do ## License StikJIT is licensed under **AGPL-3.0**. See [`LICENSE`](LICENSE) for details.