File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change @@ -28,8 +28,10 @@ A cross-platform CLI tool for driving USB LCD displays as real-time system monit
2828### 1. Build
2929
3030``` bash
31- # With Mage (recommended)
31+ # Install Mage (recommended build tool )
3232go install github.com/magefile/mage@latest
33+
34+ # Build with Mage
3335mage build
3436
3537# Or directly with Go
@@ -467,6 +469,31 @@ nvidia-smi
467469ls /sys/class/drm/card* /device/gpu_busy_percent
468470` ` `
469471
472+ # # Development with Mage
473+
474+ SensorPanel uses [Mage](https://magefile.org/) as its build tool. Install it with:
475+
476+ ` ` ` bash
477+ go install github.com/magefile/mage@latest
478+ ` ` `
479+
480+ # ## Available Targets
481+
482+ ` ` ` bash
483+ mage -l # List all targets
484+
485+ mage build # Build for current platform (default)
486+ mage install # Build and install to GOPATH/bin
487+ mage test # Run all tests
488+ mage vet # Run go vet
489+ mage lint # Run golangci-lint
490+ mage check # Run all checks (vet, test, lint)
491+ mage clean # Remove build artifacts
492+ mage release # Cross-compile for all platforms (dist/)
493+ mage dev # Build and run the dashboard
494+ mage devTheme # Build and start theme dev mode
495+ ` ` `
496+
470497# # Testing
471498
472499SensorPanel has comprehensive unit tests with good coverage across all core packages.
You can’t perform that action at this time.
0 commit comments