|
3 | 3 | <img src="./public/toolkit.png" alt="PwnStar Toolkit Banner"> |
4 | 4 | </a> |
5 | 5 | <br> |
6 | | - <img src="https://img.shields.io/badge/Python-3.11.9-%233776AB?style=for-the-badge&logo=python&logoColor=FFFFFF" alt="python"/> |
| 6 | + <img src="https://img.shields.io/badge/Python-3.11.0-%233776AB?style=for-the-badge&logo=python&logoColor=FFFFFF" alt="python"/> |
7 | 7 | <img src="https://img.shields.io/badge/linux-%23000000?style=for-the-badge&logo=linux&logoColor=FFFFFF" alt="Linux"/> |
8 | 8 | <img src="https://img.shields.io/badge/PowerShell-Badge?style=for-the-badge&logo=data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAzMiAzMiI+PHBhdGggZD0iTTggMjJsOC02LTgtNk0xOCAyMmg2IiBzdHJva2U9IiNmZmYiIHN0cm9rZS13aWR0aD0iMi4yIiBzdHJva2UtbGluZWNhcD0icm91bmQiIHN0cm9rZS1saW5lam9pbj0icm91bmQiIGZpbGw9Im5vbmUiLz48L3N2Zz4=&logoSize=auto&23ED8B00&color=%23012456&cacheSeconds=86400)](https://learn.microsoft.com/powershell" alt="PowerShell"/> |
9 | 9 |
|
|
28 | 28 | - 🔌 Modular extension support. |
29 | 29 | - 🧩 Utility tools (endian swap, number conversion, XOR). |
30 | 30 | - 🕵️ Basic pattern and frequency analysis. |
31 | | -- 📂 Workspace mode for saving outputs. |
| 31 | +- 📂 Workspace mode for saving outputs. |
32 | 32 |
|
| 33 | +## Installation Guide |
| 34 | + |
| 35 | +### Prerequisites |
| 36 | +Ensure you have the following installed on your system: |
| 37 | +- **Git** version 2.45.1 or higher |
| 38 | +- **Python** version 3.11.0 or higher |
| 39 | +- **Windows OS** (Linux/macOS support coming in future releases) |
| 40 | + |
| 41 | +**Step 1: Open Command Prompt** |
| 42 | +- Press `Windows + R`, type `cmd`, and press Enter |
| 43 | +- Or search for "Command Prompt" in the Start menu |
| 44 | + |
| 45 | +**Step 2: Navigate to Root Drive** |
| 46 | +```bash |
| 47 | +cd C:\ |
| 48 | +``` |
| 49 | +**Step 3: Clone the Repository** |
| 50 | +```bash |
| 51 | +git clone https://github.com/zyin-jessie/PwnStar-Toolkit.git |
| 52 | +``` |
| 53 | + |
| 54 | +**Step 4: Add to System PATH** |
| 55 | +- search for "Environment Variable" in the Start menu |
| 56 | +- Click "Edit the system environment variables" |
| 57 | +- Click "Environment Variables" button |
| 58 | +- Under "User variables", select "Path" and click "Edit" |
| 59 | +- Click "New" and add the following path: |
| 60 | +```bash |
| 61 | +C:\PwnStar-Toolkit |
| 62 | +``` |
| 63 | + |
| 64 | +**Step 5: Launch the Toolkit** |
| 65 | +- Open a new Command Prompt window |
| 66 | +- Type the following command: |
| 67 | +```bash |
| 68 | +pwnstar |
| 69 | +``` |
0 commit comments