docs: update readme information
Metadata
Current evaluation
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.
Suggested action: —
No scores available.
Issue body
Add basic usage information using style and content consistent
with other craft tools..
- [x] Have you followed the guidelines for contributing?
- [x] Have you signed the [CLA](http://www.ubuntu.com/legal/contributors/)?
- [x] Have you successfully run `make lint && make test`?
---
DEBCRAFT-25
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| qwen/qwen3.6-35b-a3b | — | — | 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. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged documentation updates to the README. Added basic usage information consistent with other craft tools, resolving DEBCRAFT-25. The maintainer applied the changes directly and merged the pull request. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged maintainer cmatsuoka's documentation update to the README. The changes add basic usage information aligned with other craft tools, resolving DEBCRAFT-25. All lint and test checks passed, and the update was applied directly. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #1199 docs: update README according to template | craft-parts | merged | 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. | |
| #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. | |
| #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. | |
| #9 docs: update build procedure and fix warning | craft-store | merged | Merged updates consolidate API documentation configuration in conf.py for ReadTheDocs and fix a build warning. Approved by one reviewer, passed CI, and notes propagation to related craft-* projects. | |
| #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). | |
| #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. | |
| #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. | |
| #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. | |
| #2186 docs: fix build errors | charmcraft | merged | Merged a one-line documentation fix to resolve recent build errors. Approved by two reviewers. Remaining build issues were subsequently addressed in craft-parts pull request 1021. | |
| #1091 docs: revamp craftctl how-to | craft-parts | merged | Merged documentation update revamping the craftctl how-to guide using upstream Snapcraft content. Approved by two reviewers, CI checks passed after fixes, and changelog updated for a minor release prior to merge. |