Initial commit: project docs and ignore rules

This commit is contained in:
Dr Jones
2026-05-03 23:19:51 -07:00
commit 197724f7a5
55 changed files with 35824 additions and 0 deletions

34
README.md Normal file
View File

@@ -0,0 +1,34 @@
# C5 project
Collection of **ESP32-C5** experiments: a unified toolkit and a separate WiFi penetration / lab firmware tree.
## Contents
| Path | Purpose |
|------|---------|
| `ESP32-C5-Toolkit/` | WiFi/BLE toolkit with web UI — see its [README](ESP32-C5-Toolkit/README.md). |
| `esp32-wifi-penetration-tool/` | ESP-IDF WiFi penetration / test harness (educational; legal use only). |
## Build pointers
**Toolkit**
```bash
cd ESP32-C5-Toolkit
idf.py --preview set-target esp32c5
idf.py build
```
**Penetration tool**
```bash
cd esp32-wifi-penetration-tool
idf.py set-target esp32c5
idf.py build
```
Match ESP-IDF major version with `C5 JACKED/` and other C5 trees in this workspace.
## Index
See [`WORKSPACE.md`](../WORKSPACE.md).