📝 Flesh out setup and configuration guide in README #21

Merged

mat merged 1 commit from docs/47-setup-tutorial into main

2026-07-05 07:56:46 +00:00

mat commented

2026-04-24 17:16:27 +00:00

Owner

Summary

Closes MateoGreil/homeassistant-comwatt#47.

Expands both README.md and README-fr.md with the step-by-step guide the reporter asked for: prerequisites, install path (HACS + manual), click-by-click configuration, what success looks like, and the most common failure modes.

Scope

No code change. README-only.
Both English and French versions stay in sync.

Test plan

Eyeball the rendered markdown on Forgejo / GitHub.

## Summary Closes [MateoGreil/homeassistant-comwatt#47](https://github.com/MateoGreil/homeassistant-comwatt/issues/47). Expands both `README.md` and `README-fr.md` with the step-by-step guide the reporter asked for: prerequisites, install path (HACS + manual), click-by-click configuration, what success looks like, and the most common failure modes. ## Scope - No code change. README-only. - Both English and French versions stay in sync. ## Test plan - [ ] Eyeball the rendered markdown on Forgejo / GitHub.

mat added 1 commit

2026-04-24 17:16:27 +00:00

📝 Flesh out setup and configuration guide in README

Validate / validate-hacs (push) Has been skipped

Details

Validate / validate-hassfest (push) Has been skipped

Details

Validate / lint-ruff (push) Successful in 7s

Details

Validate / test-pytest (push) Successful in 1m44s

Details

Validate / type-check-mypy (push) Successful in 1m48s

Details

Validate / validate-hacs (pull_request) Has been skipped

Details

Validate / validate-hassfest (pull_request) Has been skipped

Details

Validate / lint-ruff (pull_request) Successful in 7s

Details

Validate / test-pytest (pull_request) Successful in 1m44s

Details

Validate / type-check-mypy (pull_request) Successful in 1m48s

Details

d492315248

Closes #47.

Issue #47 asked for a step-by-step installation and configuration
guide: where to put username/password, which account to use, etc.
The previous README only said "Install via HACS … restart … add
integration", which left new users stuck.

Both READMEs (English and French) now have:

- **Prerequisites** section naming the Comwatt Gen 4 website, required
  HA version, and HACS as recommended.
- **Installation** split into "Via HACS (recommended)" — step-by-step
  for adding the repo as a custom source — and "Manual installation"
  from the Releases archive.
- **Configuration** with the exact click path, the distinction between
  Comwatt credentials and HA credentials, and the my.home-assistant.io
  shortcut badge.
- **Verifying it works** explaining what devices/entities should
  appear, where to look, and the common failure modes (wrong creds,
  backend outage, Gen 3 account needing the Indepbox integration).
- **Usage** pointer to the Energy dashboard for `*_total_energy`.