Added agent.md to make ai workflows more efficient and save tokens (#15)

Reviewed-on: #15
This commit was merged in pull request #15.
This commit is contained in:
2026-07-13 20:48:06 +01:00
parent 96217c45f6
commit da29d1a032
3 changed files with 116 additions and 9 deletions
+23 -8
View File
@@ -20,19 +20,30 @@ Daemon that makes an OpenWrt router appear as a UniFi AP to UniFi Network contro
| **LLDP Send** | Custom frames via AF_PACKET raw socket | `lldp.c``lldp_send_frame()` |
| **LLDP Read** | Neighbors for UniFi topology | `lldp.c``lldpctl -f json` |
## Using the dev container
## Building in the dev container
```shell
# OpenWRT build directory
# From the OpenWrt build root
cd /home/openwrt/openwrt
# clean Previous builds
make clean
# Build only this package
make package/OpenUniFi/compile
# Compile
make
# For a clean package rebuild
make package/OpenUniFi/clean
make package/OpenUniFi/compile
```
`Makefile.standalone` is an alternative for compiling directly on an OpenWrt
device that has the development dependencies installed:
```shell
make -f Makefile.standalone
```
Contributors and AI agents should read [`AGENTS.md`](AGENTS.md) for the concise
architecture map, invariants, and validation checklist.
## Changing Compiler Settings
```shell
@@ -52,7 +63,7 @@ make menuconfig
## Configuration
On The Accesspoint Run this to install the package:
On the access point, run the following to install the package:
```shell
# Install dependencies
@@ -77,13 +88,17 @@ lan_if = br-lan # Default Lan interface Name
ufmodel = u6-inwall # emulated model
inform_interval = 10 # inform interval
enable_announce = 1
enable_inform = 1 # Enable logging to /var/log/openuf.log if set to 1
enable_inform = 1 # Enable adoption and telemetry requests
enable_logging = 1 # Write diagnostics to /var/log/openuf.log
protocol_debug_level = 0 # 0=off, 1=safe response details,
# 2=full decrypted JSON (contains secrets)
```
Daemon settings live in `/etc/openuf/openuf.conf`. Adoption and controller state
are persisted separately in `/etc/openuf/state.json`; do not copy that file
between devices because it contains the device authentication key.
---
## Glossary