Add project usage documentation #40

Merged

JackFrostbyte merged 1 commit from feature/v0.6-issue-20-usage-docs into main

2026-05-09 23:06:53 -04:00

JackFrostbyte commented

2026-05-09 23:06:46 -04:00

Owner

Summary

Adds user-facing project documentation for RGB Aura.

This update:

expands the main README.md;
adds docs/usage.md;
repairs and completes docs/safe-failure-modes.md;
repairs and completes docs/systemd-user-service.md;
documents manual runtime usage, dry-run usage, runtime config, logs, safe stopping, and optional systemd usage;
keeps detailed failure behavior and systemd setup in their own focused documents.

Safety notes

Documentation-only change.
No animation behavior changed.
No OpenRGB write behavior changed.
Runtime guardrails remain unchanged.
Dry-run remains hardware-free.
Reserved ARGB zone remains documented as untouched.
Optional systemd service remains optional and not auto-installed.

Validation

Ran:

ruff format src/rgb_aura scripts tests
ruff check src/rgb_aura scripts tests

## Summary Adds user-facing project documentation for RGB Aura. This update: - expands the main `README.md`; - adds `docs/usage.md`; - repairs and completes `docs/safe-failure-modes.md`; - repairs and completes `docs/systemd-user-service.md`; - documents manual runtime usage, dry-run usage, runtime config, logs, safe stopping, and optional systemd usage; - keeps detailed failure behavior and systemd setup in their own focused documents. ## Safety notes - Documentation-only change. - No animation behavior changed. - No OpenRGB write behavior changed. - Runtime guardrails remain unchanged. - Dry-run remains hardware-free. - Reserved ARGB zone remains documented as untouched. - Optional systemd service remains optional and not auto-installed. ## Validation Ran: ```bash ruff format src/rgb_aura scripts tests ruff check src/rgb_aura scripts tests

JackFrostbyte added 1 commit

2026-05-09 23:06:46 -04:00