docs: transformed README into a visual, picture-book style cyber guide #18
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,61 +1,187 @@ | ||
| # Kali-Linux-for-Android — Kali Magic 🎩🔐 | ||
|
|
||
| > Transform your Android device into a **portable cybersecurity playground** — run Kali / NetHunter tools on Android (Termux / LinuxDroid integration). 🚀💻📱 | ||
| [](LICENSE) | ||
| [](https://github.com/AryanVBW/ParrotSecurityOsForAndroid/releases) | ||
| []() | ||
|
|
||
| --- | ||
|
|
||
| > ```bash | ||
| > mkdir -p assets/gifs | ||
| > wget -O assets/gifs/nmap-scan.gif "https://upload.wikimedia.org/wikipedia/commons/3/3b/Terminal_demo.gif" | ||
| > wget -O assets/gifs/metasploit-demo.gif "https://upload.wikimedia.org/wikipedia/commons/5/5f/Metasploit_Console.gif" | ||
| > wget -O assets/gifs/wireshark-capture.gif "https://upload.wikimedia.org/wikipedia/commons/6/6d/Wireshark_capture.gif" | ||
| > wget -O assets/gifs/linuxdroid-install.gif "https://upload.wikimedia.org/wikipedia/commons/1/1a/Installer_demo.gif" | ||
| > wget -O assets/gifs/kali-logo.png "https://upload.wikimedia.org/wikipedia/commons/2/2b/Kali-dragon-icon.png" | ||
| > wget -O assets/gifs/parrot-logo.png "https://upload.wikimedia.org/wikipedia/commons/8/8b/Parrot-logo.png" | ||
| > wget -O assets/gifs/ubuntu-logo.png "https://upload.wikimedia.org/wikipedia/commons/a/ab/Logo-ubuntu_cof-orange-hex.svg" | ||
| > wget -O assets/gifs/debian-logo.png "https://upload.wikimedia.org/wikipedia/commons/0/0d/Debian-logo.svg" | ||
| > git add assets/gifs/* | ||
| > git commit -m "Add README demo assets" | ||
| > git push origin main | ||
| > ``` | ||
| --- | ||
| ## 📖 Table of Contents | ||
| - [About](#about) | ||
| - [Supported Operating Systems](#supported-operating-systems) | ||
| - [Features](#features) | ||
| - [Prerequisites](#prerequisites) | ||
| - [Quick Install](#quick-install) | ||
| - [Manual Installation](#manual-installation) | ||
| - [Kali NetHunter (Rootless)](#kali-nethunter-rootless) | ||
| - [Visual Demos](#visual-demos) | ||
| - [Nmap](#nmap) | ||
| - [Metasploit](#metasploit) | ||
| - [Wireshark](#wireshark) | ||
| - [Installer Walkthrough](#installer-walkthrough) | ||
| - [Usage Examples](#usage-examples) | ||
| - [Installation Link](#installation-link) | ||
| - [Security & Legal Notice](#security--legal-notice) | ||
| - [Contributing & Support](#contributing--support) | ||
| - [Credits & License](#credits--license) | ||
|
Comment on lines
+28
to
+46
There was a problem hiding this comment. 🧩 Analysis chainVerify all Table of Contents sections exist in the complete file. Static analysis flags all TOC links as invalid (MD051 errors, lines 30–46). The provided code snippet ends at line 187, making it impossible to confirm whether all 15+ referenced sections have corresponding The TOC references these sections that are not visible in the provided code:
Run this verification script to ensure all TOC anchors resolve: If sections are missing, add them with appropriate heading levels and placeholder content. 🏁 Script executed: #!/bin/bash
# Extract all TOC link anchors and verify corresponding ## headings exist
echo "=== TOC Anchors (from lines 30-46) ==="
rg -A 16 '📖 Table of Contents' README.md | rg '\(#[^)]+\)' -o | sed 's/[()#]//g' | sort | uniq
echo -e "\n=== Heading Anchors (from ## lines) ==="
rg '^##+ ' README.md | sed 's/^##* //; s/[^a-z0-9 -]//g; s/ /-/g' | tr '[:upper:]' '[:lower:]' | sort | uniq
echo -e "\n=== Checking for missing sections ==="
for section in "manual-installation" "kali-nethunter-rootless" "visual-demos" "nmap" "metasploit" "wireshark" "installer-walkthrough" "usage-examples" "installation-link" "security--legal-notice" "contributing--support" "credits--license"; do
if rg -q "^## .* $section" README.md; then
echo "✓ $section"
else
echo "✗ MISSING: $section"
fi
doneLength of output: 767 I need to run a cleaner verification to get reliable results about which sections actually exist. 🏁 Script executed: #!/bin/bash
# Get all ## headings directly without complex regex
echo "=== All ## Headings (raw) ==="
rg '^## ' README.md | head -20
echo -e "\n=== Heading count ==="
rg '^## ' README.md | wc -l
echo -e "\n=== All ### Subsection headings ==="
rg '^### ' README.md | head -20Length of output: 241 I need to rerun the verification with the repository cloned. 🏁 Script executed: #!/bin/bash
# Get all ## headings directly without complex regex
echo "=== All ## Headings (raw) ==="
rg '^## ' README.md | head -30
echo -e "\n=== Heading count ==="
rg '^## ' README.md | wc -l
echo -e "\n=== All ### Subsection headings ==="
rg '^### ' README.md | head -30
echo -e "\n=== Total file lines ==="
wc -l README.mdLength of output: 256 Add 12 missing sections referenced in the Table of Contents or remove them from TOC. Only 5 of the 15 sections referenced in the TOC (lines 28–46) have corresponding
The file contains only 187 lines with 6 total 🧰 Tools🪛 markdownlint-cli2 (0.18.1)30-30: Link fragments should be valid (MD051, link-fragments) 31-31: Link fragments should be valid (MD051, link-fragments) 32-32: Link fragments should be valid (MD051, link-fragments) 33-33: Link fragments should be valid (MD051, link-fragments) 34-34: Link fragments should be valid (MD051, link-fragments) 35-35: Link fragments should be valid (MD051, link-fragments) 36-36: Link fragments should be valid (MD051, link-fragments) 37-37: Link fragments should be valid (MD051, link-fragments) 38-38: Link fragments should be valid (MD051, link-fragments) 39-39: Link fragments should be valid (MD051, link-fragments) 40-40: Link fragments should be valid (MD051, link-fragments) 41-41: Link fragments should be valid (MD051, link-fragments) 42-42: Link fragments should be valid (MD051, link-fragments) 43-43: Link fragments should be valid (MD051, link-fragments) 44-44: Link fragments should be valid (MD051, link-fragments) 45-45: Link fragments should be valid (MD051, link-fragments) 46-46: Link fragments should be valid (MD051, link-fragments) 🤖 Prompt for AI Agents |
||
| --- | ||
| ## 🧠 About | ||
| **Kali Magic** lets you experience **Kali Linux / Parrot OS / NetHunter** tools right on Android — perfect for **students, researchers, and ethical hackers** learning on the go. | ||
| Run full penetration-testing environments inside **Termux + LinuxDroid**. | ||
| It’s portable, rootless, and visually documented with live demos. | ||
| [](https://github.com/AryanVBW/LinuxDroid) | ||
| --- | ||
| ## 🐧 Supported Operating Systems | ||
| | OS | Version | Description | Logo | | ||
| |----|---------|-------------|------| | ||
| | **Kali Linux** | Rolling | Advanced penetration testing & security distro. |  | | ||
| | **Parrot Security OS** | Rolling | Forensics, pen-testing, privacy & dev tools. |  | | ||
| | **Ubuntu** | 20.04+ | General-purpose Linux for dev & scripting. |  | | ||
| | **Debian** | 11+ | Stable, server-ready Linux distribution. |  | | ||
|
Comment on lines
+61
to
+68
There was a problem hiding this comment. 🧩 Analysis chainVerify image asset paths exist in the repository. The Supported Operating Systems table (lines 61–68) references image files from
These asset paths should be verified to ensure they:
Run this script to verify image asset presence and size: If any assets are missing or external (from Wikimedia), document this clearly in the README or ensure they are committed to the repository. 🏁 Script executed: #!/bin/bash
# Verify all image assets referenced in README exist and check dimensions
echo "=== Image Assets Referenced in README ==="
rg '!\[.*?\]\(assets/gifs/[^)]+\)' README.md -o
echo -e "\n=== Checking for file existence ==="
for asset in assets/gifs/kali-logo.png assets/gifs/parrot-logo.png assets/gifs/ubuntu-logo.png assets/gifs/debian-logo.png assets/gifs/linuxdroid-install.gif assets/gifs/nmap-scan.gif assets/gifs/metasploit-demo.gif assets/gifs/wireshark-capture.gif; do
if [ -f "$asset" ]; then
size=$(du -h "$asset" | cut -f1)
echo "✓ $asset ($size)"
else
echo "✗ MISSING: $asset"
fi
done
echo -e "\n=== Image Dimensions (if ImageMagick available) ==="
if command -v identify >/dev/null 2>&1; then
for img in assets/gifs/*.{png,gif}; do
[ -f "$img" ] && identify "$img" || true
done
fiLength of output: 684 All referenced image assets are missing from the repository. The README.md contains 5 image references (lines 57, 62–65) that do not exist in the repository:
This results in broken image links throughout the documentation. Either:
🧰 Tools🪛 LanguageTool[style] ~68-~68: Using many exclamation marks might seem excessive (in this case: 5 exclamation marks for a text that’s 2177 characters long) (EN_EXCESSIVE_EXCLAMATION) 🤖 Prompt for AI Agents |
||
| --- | ||
| ## 🌟 Features | ||
| - Mobile-optimized environment for Kali / NetHunter tools. | ||
| - Run powerful pentest tools inside Termux/proot (rootless). | ||
| - Quick installer + visual setup walkthrough. | ||
| - Lightweight GIF demos and prebuilt commands. | ||
| - Safe for educational / ethical security labs. | ||
| --- | ||
| ## ⚙️ Prerequisites | ||
| - Android 7.0+ | ||
| - Termux (from F-Droid) | ||
| - `termux-setup-storage` permission granted | ||
| - Disk: ~3-8 GB free space | ||
| - (Optional) Root access for Wi-Fi injection or OTG tools | ||
| > 💡 Always inspect scripts before running: | ||
| > ```bash | ||
| > cat install.sh | ||
| > ``` | ||
| --- | ||
| ## 🚀 Quick Install | ||
| ```bash | ||
| pkg update && pkg upgrade -y | ||
| pkg install wget curl proot -y | ||
| # Download & run Kali NetHunter installer | ||
| wget -O install-nethunter-termux https://offs.ec/2MceZWr | ||
| chmod +x install-nethunter-termux | ||
| ./install-nethunter-termux | ||
| # Optional extras (LinuxDroid) | ||
| wget https://raw.githubusercontent.com/AryanVBW/LinuxDroid/main/Scripts/menu.sh && chmod +x menu.sh | ||
| # Optional bash presets | ||
| cp ~/.bashrc ~/.bashrc.backup || true | ||
| wget https://raw.githubusercontent.com/AryanVBW/LinuxDroid/main/Scripts/default.bashrc -O ~/.bashrc | ||
| # Start GUI | ||
| nethunter kex & | ||
| ./menu.sh | ||
| pkg install proot-distro | ||
| proot-distro list | ||
| proot-distro install debian | ||
| proot-distro login debian | ||
| # Inside Debian | ||
| apt update && apt upgrade -y | ||
| apt install kali-tools-top10 -y | ||
| wget -O install-nethunter-termux https://offs.ec/2MceZWr | ||
| chmod +x install-nethunter-termux | ||
| ./install-nethunter-termux | ||
| nethunter kex & | ||
| nmap -A 192.168.1.1/24 | ||
| msfconsole | ||
| use exploit/android/browser/webview_addjavascriptinterface | ||
| # List installed tools | ||
| ls /usr/share/ | ||
| # Start Metasploit | ||
| msfconsole | ||
| # Network Scan | ||
| nmap -sS 192.168.1.0/24 | ||
AryanVBW marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| mkdir -p scripts | ||
| cat > scripts/optimize_gifs.sh <<'EOF' | ||
| #!/usr/bin/env bash | ||
| # optimize_gifs.sh | ||
| # Example: ./optimize_gifs.sh 640 15 | ||
| set -e | ||
| MAX_WIDTH="${1:-640}" | ||
| FPS="${2:-15}" | ||
| SRC_DIR="assets/gifs" | ||
| OUT_DIR="${SRC_DIR}/optimized" | ||
| mkdir -p "$OUT_DIR" | ||
| if ! command -v ffmpeg >/dev/null 2>&1; then | ||
| pkg install -y ffmpeg || apt install -y ffmpeg | ||
| fi | ||
| if ! command -v gifsicle >/dev/null 2>&1; then | ||
| pkg install -y gifsicle || apt install -y gifsicle || true | ||
| fi | ||
| for gif in "$SRC_DIR"/*.gif; do | ||
| fname="$(basename "$gif")" | ||
| tmp="${OUT_DIR}/tmp-${fname}" | ||
| out="${OUT_DIR}/${fname%.*}-opt.gif" | ||
| ffmpeg -y -i "$gif" -vf "scale='min(${MAX_WIDTH},iw)':'-2',fps=${FPS}" "$tmp" | ||
| if command -v gifsicle >/dev/null 2>&1; then | ||
| gifsicle -O3 "$tmp" -o "$out" | ||
| else | ||
| mv "$tmp" "$out" | ||
| fi | ||
| echo "Optimized: $out" | ||
| done | ||
| EOF | ||
| chmod +x scripts/optimize_gifs.sh | ||
| ./scripts/optimize_gifs.sh 640 15 | ||
| git add assets/gifs/optimized/* | ||
| git commit -m "Add optimized README GIFs" | ||
| git push origin main | ||
| --- | ||
Uh oh!
There was an error while loading. Please reload this page.