docs: update README according to template
Metadata
Current evaluation
Merged after two approvals and passing CI. Updates the README to align with a standard template, heavily inspired by Craft Application, modifying one file with 40 additions and 11 deletions.
Suggested action: —
No scores available.
Issue body
- [x] Have you signed the [CLA](http://www.ubuntu.com/legal/contributors/)?
- [ ] Have you added an entry to the changelog (`docs/reference/changelog.rst`)?
-----
Updates README according to the template with strong influence from [Craft Application's](https://github.com/canonical/craft-application/blob/259acbadcf291f3bf47e3e3dfc2d3cebdb1121ef/README.md) current README.
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| qwen/qwen3.6-35b-a3b | — | — | Merged after two approvals and passing CI. Updates the README to align with a standard template, heavily inspired by Craft Application, modifying one file with 40 additions and 11 deletions. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged a maintainer request updating the README to align with a standard template, heavily influenced by the Craft Application project. Accepted without review comments. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #2283 docs: align README with model | charmcraft | merged | Merged after approval. The update aligned the project README with the official template and resolved local build errors caused by unused Craft Parts documentation. Two files were modified, resulting in 79 additions and 49 deletions. | |
| #114 docs: update readme information | debcraft | merged | Merged after two approvals and passing CI checks. Updates the README with basic usage information consistent with other craft tools, resolving DEBCRAFT-25. Review feedback was incorporated prior to merge. | |
| #387 docs: add readme template | starbase | merged | Merged after approval by two reviewers and successful CI checks. The pull request introduced a README template, adding 73 lines and removing 7 across two files to standardize project documentation. | |
| #554 docs: update docs subproject readme | starbase | merged | Merged. Updated the docs subproject readme to correct outdated instructions and clarify that the documentation targets craft apps contributors. Approved by reviewers and passed all CI checks. | |
| #49 Improved README and docs on how to use the lib (CRAFT-707). | craft-cli | merged | Successfully merged documentation updates improving the README and library usage guide. Approved by one reviewer, modified seven files with 582 additions and 10 deletions, resolving CRAFT-707. | |
| #258 docs: update readme and template, fix build error | starbase | merged | Merged after two reviewer approvals and passing CI. Updated README wording, added doc preparation details, and disabled PDF and EPUB generation to resolve build errors. All changes passed tests with 100% coverage. | |
| #103 docs: update package documentation (CRAFT-37) | craft-parts | merged | Merged documentation updates reorganizing the layout, improving docstrings, and adding lifecycle and class diagrams. Approved by two reviewers, passed CI, and changed 21 files (+511/-83). | |
| #368 docs: update CONTRIBUTING.md | craft-cli | merged | Merged following two reviewer approvals and successful CI checks. Updates CONTRIBUTING.md to align with the standard template, applying 107 additions and 55 deletions to a single file. | |
| #826 docs: update CONTRIBUTING.md | craft-application | merged | Merged documentation update aligning CONTRIBUTING.md with the official template. Approved by three reviewers with all CI checks passing. The change modifies one file with 104 additions and 48 deletions. | |
| #233 Docs: Add README template | starbase | closed | Resolved by merging PR #387 in canonical/starbase. A standardized Markdown README template for craft projects was implemented, covering installation, build steps, and licensing requirements. |