Procházet zdrojové kódy

Merge pull request #5 from z0xca/main

refactor(docs): Improve README.md formatting
rhcp011235 před 2 měsíci
rodič
revize
dd9bef1d01
1 změnil soubory, kde provedl 39 přidání a 36 odebrání
  1. 39 36
      README.md

+ 39 - 36
README.md

@@ -1,75 +1,78 @@
-iOS Activation Tool Suite
+# iOS Activation Tool Suite
 
 
 A complete, end-to-end solution for iOS device activation management. This repository contains both the client-side automation logic and the server-side infrastructure required to handle device activation payloads.
 A complete, end-to-end solution for iOS device activation management. This repository contains both the client-side automation logic and the server-side infrastructure required to handle device activation payloads.
 
 
-Architecture Overview
+## Architecture Overview
 
 
 The suite is divided into two core components:
 The suite is divided into two core components:
 
 
-Client Automation (client/): A Python-based utility that interacts directly with connected iOS devices via USB. It handles lifecycle management (reboots), system log analysis, and filesystem operations (AFC).
+- **Client Automation (`client/`)**: A Python-based utility that interacts directly with connected iOS devices via USB. It handles lifecycle management (reboots), system log analysis, and filesystem operations (AFC).
 
 
-Server Backend (server/): A PHP application that dynamically generates device-specific activation payloads. It serves as the central authority for handling device requests and delivering the necessary configuration databases.
+- **Server Backend (`server/`)**: A PHP application that dynamically generates device-specific activation payloads. It serves as the central authority for handling device requests and delivering the necessary configuration databases.
 
 
-Repository Structure
+## Repository Structure
 
 
+```
 .
 .
-├── client/                 # Python client application
-│   ├── activator.py        # Main automation entry point
-│   └── README.md           # Client-specific documentation
-├── server/                 # PHP backend infrastructure
-│   ├── public/             # Web root
-│   ├── templates/          # SQL templates for payload generation
-│   ├── assets/             # Device configuration storage
-│   └── SETUP.md            # Server deployment guide
-└── package_builder.sh      # Deployment automation utility
+├── client             # Python client application
+│   ├── activator.py   # Main automation entry point
+│   └── README.md      # Client-specific documentation
+└── server             # PHP backend infrastructure
+    ├── assets         # Device configuration storage
+    ├── public         # Web root
+    ├── SETUP.md       # Server deployment guide
+    └── templates      # SQL templates for payload generation
+```
 
 
 
 
-Prerequisites
+## Prerequisites
 
 
-Client-Side (macOS)
+### Client-Side (macOS/Linux)
 
 
-Python 3.6+
+- Python 3.6+
 
 
-libimobiledevice (via Homebrew)
+- `libimobiledevice` (via Homebrew on macOS)
 
 
-pymobiledevice3 (via pip)
+- `pymobiledevice3` (via pip)
 
 
-curl
+- `curl`
 
 
-Server-Side
+### Server-Side
 
 
-PHP 7.4 or newer
+- PHP 7.4 or newer
 
 
-SQLite3 extension enabled
+- SQLite3 extension enabled
 
 
-Write permissions for cache directories
+- Write permissions for cache directories
 
 
-Quick Start
-
-1. Build Release Package
+## Quick Start
+### 1. Build Release Package
 
 
 Use the included builder utility to generate a deployable package. This handles asset extraction and directory setup automatically.
 Use the included builder utility to generate a deployable package. This handles asset extraction and directory setup automatically.
 
 
+```bash
 chmod +x package_builder.sh
 chmod +x package_builder.sh
 ./package_builder.sh
 ./package_builder.sh
+```
 
 
+This will generate `release_package.tar.gz`.
 
 
-This will generate release_package.tar.gz.
-
-2. Server Deployment
+### 2. Server Deployment
 
 
-Deploy the contents of the server directory from the release package to your web host. Ensure the public folder is set as the document root.
+Deploy the contents of the `server` directory from the release package to your web host. Ensure the `public` folder is set as the document root.
 
 
-See server/SETUP.md for detailed configuration steps.
+See [server/SETUP.md](server/SETUP.md) for detailed configuration steps.
 
 
-3. Client Configuration
+### 3. Client Configuration
 
 
-Update the activator.py script to point to your deployed server URL before running.
+Update the `activator.py` script to point to your deployed server URL before running.
 
 
-# Run the client tool
+### 4. Run the client tool
+```
 sudo python3 client/activator.py
 sudo python3 client/activator.py
+```
 
 
 
 
-Disclaimer
+## Disclaimer
 
 
 This tool is provided for educational and research purposes only. The authors are not responsible for any misuse of this software or damage to devices. Ensure you have authorization before performing operations on any device.
 This tool is provided for educational and research purposes only. The authors are not responsible for any misuse of this software or damage to devices. Ensure you have authorization before performing operations on any device.