Skip to content

Commit df877d9

Browse files
better readme and now debug exocutable
1 parent 8b1fff4 commit df877d9

File tree

1 file changed

+21
-9
lines changed

1 file changed

+21
-9
lines changed

README.md

+21-9
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
1-
Here's the corrected and final version of your `README.md` with proper formatting, fixed code blocks, and your local screenshot path updated to a GitHub-friendly relative path (`screenshots/ui.png`). Just copy and paste this into your `README.md` file on GitHub:
21

3-
---
42

5-
### ✅ Final `README.md`
3+
---
64

75
```markdown
86
# 🧭 iOS Safari Remote Debugger GUI
@@ -42,13 +40,13 @@ pip install requests beautifulsoup4
4240

4341
---
4442

45-
## 🛠️ Setup
43+
## 🛠️ Setup from Source
4644

4745
1. Clone this repository:
4846

4947
```bash
50-
git clone https://github.com/longkidkoolstar/ios-safari-debugger-gui.git
51-
cd ios-safari-debugger-gui
48+
git clone https://github.com/longkidkoolstar/IOS-Debugger.git
49+
cd IOS-Debugger
5250
```
5351

5452
2. Run the GUI:
@@ -63,6 +61,20 @@ python main.py
6361
6462
---
6563

64+
## 📦 Download (Prebuilt)
65+
66+
No Python setup required! Download the latest prebuilt `.exe` from the releases page:
67+
68+
🔗 [Download main.exe from GitHub Releases →](https://github.com/longkidkoolstar/IOS-Debugger/releases/tag/V1.0.0)
69+
70+
Assets:
71+
- 🗂 [IOS-Debugger.zip](https://github.com/longkidkoolstar/IOS-Debugger/releases/download/V1.0.0/IOS-Debugger.zip)
72+
- ⚙️ [main.exe](https://github.com/longkidkoolstar/IOS-Debugger/releases/download/V1.0.0/main.exe)
73+
- 🧾 [Source Code (zip)](https://github.com/longkidkoolstar/IOS-Debugger/archive/refs/tags/V1.0.0.zip)
74+
- 🧾 [Source Code (tar.gz)](https://github.com/longkidkoolstar/IOS-Debugger/archive/refs/tags/V1.0.0.tar.gz)
75+
76+
---
77+
6678
## 🧪 Usage
6779

6880
- Click `Start Debugging Server` to launch the local server.
@@ -77,9 +89,10 @@ python main.py
7789
```
7890
.
7991
├── main.py # The main application file
80-
├── README.md # This file
92+
├── main.exe # Precompiled executable (Windows only)
8193
├── screenshots/
8294
│ └── ui.png # Screenshot of the GUI
95+
├── README.md # This file
8396
└── .ios_safari_debugger.ini # Auto-generated config file (saves WebKit path)
8497
```
8598

@@ -95,6 +108,7 @@ python main.py
95108

96109
- This tool does **not** include WebKit itself. You need to [build WebKit from source](https://webkit.org) or use a precompiled version with `start.sh` or `start.ps1`.
97110
- Make sure port `9221` is available and not blocked by firewalls.
111+
- Tested on Windows 10. macOS and Linux should work if you run the `.py` script manually.
98112

99113
---
100114

@@ -107,7 +121,5 @@ This project is licensed under the MIT License. See the `LICENSE` file for more
107121
## 🙏 Credits
108122

109123
Built by [longkidkoolstar](https://github.com/longkidkoolstar). Inspired by Apple's WebKit DevTools and the desire for a simple UI to debug iOS Safari.
110-
```
111124

112-
---
113125

0 commit comments

Comments
 (0)