Skip to content

Commit 4914dcd

Browse files
feat: update README to clarify zero external dependencies and remove CGO requirements
1 parent 897a001 commit 4914dcd

1 file changed

Lines changed: 3 additions & 5 deletions

File tree

README.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ A lightweight, self-hosted network monitoring dashboard. Tracks latency, jitter,
1818
- **Network change detection** — automatically detects Wi-Fi/network switches and tags measurements per network; works on macOS, Linux, Windows, Docker, and Raspberry Pi
1919
- **Settings UI** — configure ping targets, DNS targets, and intervals directly from the dashboard; changes persist across restarts
2020
- **`config.json`** — file-based defaults loaded at startup; overridden by any settings saved via the UI
21+
- **Zero external dependencies** — stdlib HTTP server, pure-Go SQLite driver; no CGO, no C compiler required
2122
- **Lightweight** — pings every 60s, speed test every 30min (1 MB); negligible network overhead
2223
- **SQLite storage** — no database server; data persists in a single file
2324
- **Cross-platform** — runs on Linux (x86, ARM/Pi), macOS, Windows, and Docker
@@ -48,7 +49,7 @@ Then open **http://localhost:8080**.
4849

4950
### Build from source
5051

51-
Requires Go 1.21+ and a C compiler (`gcc`) for the SQLite driver.
52+
Requires Go 1.21+ only — no C compiler needed.
5253

5354
```bash
5455
git clone https://github.com/decoded-cipher/netmon.git
@@ -121,14 +122,11 @@ web/
121122
### Raspberry Pi
122123

123124
```bash
124-
GOOS=linux GOARCH=arm64 CGO_ENABLED=1 CC=aarch64-linux-gnu-gcc \
125-
go build -o netmon ./cmd/netmon
125+
GOOS=linux GOARCH=arm64 go build -o netmon ./cmd/netmon
126126
```
127127

128128

129129
## Requirements
130130

131131
- **Go 1.21+** for building from source
132-
- **CGO enabled** (`CGO_ENABLED=1`) — required by the SQLite driver (`go-sqlite3`)
133-
- A C compiler (`gcc` / `musl-gcc` / `clang`) at build time; not needed at runtime
134132
- `ping` available in `PATH` at runtime (standard on all platforms)

0 commit comments

Comments
 (0)