GRI-1907: the README is for users; Docker and native install; contributor material moves to CONTRIBUTING.md #122

Merged
vivy merged 1 commit from docs/GRI-1907-readme-app-only into dev 2026-11-11 00:31:55 +00:00
Owner

GRI-1907. The product owner asked that the root README holds only what the app is and how to install it — with Docker and directly on the OS; contributor and agent material moves to a separate file.

  • README.md: what signage is, features, state; server install with Docker Compose and directly on the OS (systemd); client install (.deb); health check; HTTPS note; docs table; licence.
  • CONTRIBUTING.md (new): plan map, layout, build and test, local gates, run from source, branch rules.

Local gates: all passed on 42ce0f1.

GRI-1907. The product owner asked that the root README holds only what the app is and how to install it — with Docker and directly on the OS; contributor and agent material moves to a separate file. - `README.md`: what signage is, features, state; server install with Docker Compose and directly on the OS (systemd); client install (`.deb`); health check; HTTPS note; docs table; licence. - `CONTRIBUTING.md` (new): plan map, layout, build and test, local gates, run from source, branch rules. Local gates: all passed on 42ce0f1.
GRI-1907: the README is for users — Docker and native install for server and client; contributor material moves to CONTRIBUTING.md
Some checks failed
CI / the pre-push hook (pull_request) Successful in 11s
CI / cargo fmt (pull_request) Successful in 10s
CI / cargo deny (pull_request) Successful in 59s
CI / cargo deny advisories (pull_request) Failing after 58s
CI / cargo clippy (pull_request) Successful in 10m9s
CI / repository boundary (pull_request) Successful in 11s
CI / cargo test (pull_request) Successful in 12m8s
CI / frontend-web (pull_request) Successful in 10m5s
CI / CI (pull_request) Successful in 7s
CI / Notify gate failed (pull_request) Has been skipped
42ce0f141a
vivy merged commit 2a8a3dedd0 into dev 2026-11-11 00:31:55 +00:00
vivy deleted branch docs/GRI-1907-readme-app-only 2026-11-11 00:31:56 +00:00
Sign in to join this conversation.
No reviewers
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set

Reference
Grimoirix/grimoire-of-digital-signage!122
No description provided.