docs: refresh README (AI-assisted) by igorpecovnik · Pull Request #10245 · armbian/build

igorpecovnik · Jul 20, 2026

Automated README refresh generated by the Maintenance: Update README (AI)
workflow in armbian.github.io.

The content is generated by Claude from this repository's own files (file tree,
manifests, workflows, existing README). Please review for accuracy before
merging — edit or close if anything is wrong.

Leave review comments here: while this PR stays open, the next run reads them
and folds your fixes into the regenerated README (they won't be overwritten).

Summary by CodeRabbit

Documentation
- Modernized and expanded the README with clearer project information.
- Added build host requirements, repository layout, board support status guidance, and CI workflow details.
- Documented GitHub Action inputs and usage.
- Updated contributing guidance and added links to resources.
- Added project licensing information.

coderabbitai · Jul 20, 2026

📝 Walkthrough

Walkthrough

README.md expands build and repository documentation, describes board status, automation, GitHub Action inputs, workflows, and resources, updates contribution guidance, and adds GPLv2 licensing information.

Changes

README Documentation

Layer / File(s)	Summary
Build and project operation documentation `README.md`	Updates the introduction and Quick Start link, and documents build requirements, tooling, repository layout, board configuration status, GitHub Actions, CI workflows, and resources.
Contribution and license updates `README.md`	References `.github/labels.yml` for contribution labels and adds a GPLv2 license section linking to `LICENSE`.

Estimated code review effort: 2 (Simple) | ~10 minutes

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly summarizes the main change: a README documentation refresh.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

✨ Finishing Touches

🧪 Generate unit tests (beta)

Create PR with unit tests
Commit unit tests in branch chore/update-readme

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands.}

coderabbitai

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@README.md`:
- Around line 78-80: Update the Bash tooling description in README.md to exclude
`.github/workflows/*` as Bash files. Limit the statement to `compile.sh`,
content under `lib/`, and shell-based `run:` steps within workflow definitions,
while preserving the existing Bash version and shell-option details.
- Around line 50-74: Update the repository layout table entry containing
config/cli/, config/desktop/, and config/distributions/ to remove the
nonexistent config/desktop/ path, while preserving the descriptions and
references for the existing directories.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

Push a commit to this branch (recommended)
Create a new PR with the fixes

ℹ️ Review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: 579f12e4-9009-4307-883f-41c612dc56c2

📥 Commits

Reviewing files that changed from the base of the PR and between 58822cf and 8264e1c.

📒 Files selected for processing (1)

README.md

coderabbitai

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@README.md`:
- Line 91: Update the README usage section describing the composite action
inputs to explicitly include the required armbian_token input alongside the
existing input list. Keep the description aligned with action.yml and identify
armbian_token as mandatory.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

Push a commit to this branch (recommended)
Create a new PR with the fixes

ℹ️ Review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: d04201a9-071b-4e31-94d6-b7cb4555bb37

📥 Commits

Reviewing files that changed from the base of the PR and between 8264e1c and 4938723.

📒 Files selected for processing (1)

README.md

coderabbitai

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@README.md`:
- Around line 52-76: Update the repository-layout fenced code block in README.md
to specify a language, using text or tree after the opening fence while
preserving its contents unchanged.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

Push a commit to this branch (recommended)
Create a new PR with the fixes

ℹ️ Review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: 1a670c94-6a77-49f8-b56e-d55f8c17183e

📥 Commits

Reviewing files that changed from the base of the PR and between 4938723 and 0ae3bfc.

📒 Files selected for processing (1)

README.md

coderabbitai · Jul 27, 2026

+```
+.
+├── compile.sh              # Main entrypoint (Bash)
+├── action.yml              # Composite GitHub Action ("Rebuild Armbian")
+├── VERSION
+├── lib/                    # Build framework Bash libraries (sourced by compile.sh)
+├── config/
+│   ├── boards/             # Per-board configs (.conf / .csc / .wip / .eos / .tvb)
+│   ├── bootenv/            # U-Boot environment fragments
+│   ├── bootscripts/        # boot-*.cmd sources (compiled to boot.scr)
+│   ├── cli/                # CLI (server/minimal) package lists per release
+│   ├── distributions/      # Supported Debian/Ubuntu release metadata
+│   ├── sources/            # SoC family definitions (families/…)
+│   └── its/                # Image Tree Source files for FIT images
+├── packages/               # Debian packaging helpers
+│   ├── bsp/                # Board-support package pieces
+│   ├── bsp-cli/            # Files shipped in armbian-cli-* packages
+│   └── bsp-desktop/        # Files shipped in armbian-desktop-* packages
+├── extensions/             # Optional build-time extensions
+├── patch/                  # Kernel, U-Boot, ATF and misc. patch series
+│   ├── kernel/archive/…    # Per-family/-version kernel patchsets & DT overlays
+│   └── u-boot/…            # Per-version U-Boot patchsets (see per-dir READMEs)
+├── tools/                  # Small helper tools (mk_format_patch, unifying_configs)
+└── .github/                # Workflows, issue templates, CODEOWNERS, labels
+```


📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win

Specify a language for the repository-layout code fence.

Markdownlint reports MD040 at Line 52. Use text or tree for the fenced block.

Proposed fix

-``` +```text

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

```

.

├── compile.sh # Main entrypoint (Bash)

├── action.yml # Composite GitHub Action ("Rebuild Armbian")

├── VERSION

├── lib/ # Build framework Bash libraries (sourced by compile.sh)

├── config/

│ ├── boards/ # Per-board configs (.conf / .csc / .wip / .eos / .tvb)

│ ├── bootenv/ # U-Boot environment fragments

│ ├── bootscripts/ # boot-*.cmd sources (compiled to boot.scr)

│ ├── cli/ # CLI (server/minimal) package lists per release

│ ├── distributions/ # Supported Debian/Ubuntu release metadata

│ ├── sources/ # SoC family definitions (families/…)

│ └── its/ # Image Tree Source files for FIT images

├── packages/ # Debian packaging helpers

│ ├── bsp/ # Board-support package pieces

│ ├── bsp-cli/ # Files shipped in armbian-cli-* packages

│ └── bsp-desktop/ # Files shipped in armbian-desktop-* packages

├── extensions/ # Optional build-time extensions

├── patch/ # Kernel, U-Boot, ATF and misc. patch series

│ ├── kernel/archive/… # Per-family/-version kernel patchsets & DT overlays

│ └── u-boot/… # Per-version U-Boot patchsets (see per-dir READMEs)

├── tools/ # Small helper tools (mk_format_patch, unifying_configs)

└── .github/ # Workflows, issue templates, CODEOWNERS, labels

```

🧰 Tools

🪛 markdownlint-cli2 (0.23.0)

[warning] 52-52: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

🤖 Prompt for AI Agents

Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@README.md` around lines 52 - 76, Update the repository-layout fenced code block in README.md to specify a language, using text or tree after the opening fence while preserving its contents unchanged.

Source: Linters/SAST tools

igorpecovnik added the Documentation Documentation changes or additions label Jul 20, 2026

github-actions Bot added size/medium PR with more then 50 and less then 250 lines 08 Milestone: Third quarter release Needs review Seeking for review labels Jul 20, 2026

EvilOlaf reviewed Jul 20, 2026

View reviewed changes

Comment thread README.md Outdated

igorpecovnik mentioned this pull request Jul 21, 2026

readme-updater: make the AI README generator feedback-aware armbian/armbian.github.io#365

Merged

igorpecovnik force-pushed the chore/update-readme branch from 58822cf to 8264e1c Compare July 24, 2026 14:33

coderabbitai Bot reviewed Jul 24, 2026

View reviewed changes

Comment thread README.md Outdated

Comment thread README.md Outdated

igorpecovnik force-pushed the chore/update-readme branch from 8264e1c to 4938723 Compare July 24, 2026 14:53

coderabbitai Bot reviewed Jul 24, 2026

View reviewed changes

Comment thread README.md Outdated

docs: refresh README (AI-assisted)

0ae3bfc

igorpecovnik force-pushed the chore/update-readme branch from 4938723 to 0ae3bfc Compare July 27, 2026 08:49

coderabbitai Bot reviewed Jul 27, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

docs: refresh README (AI-assisted) - #10245

docs: refresh README (AI-assisted)#10245
igorpecovnik wants to merge 1 commit into
mainarmbian/build:mainfrom
chore/update-readmearmbian/build:chore/update-readmeCopy head branch name to clipboard

igorpecovnik commented Jul 20, 2026 •

edited by coderabbitai Bot

Loading

Uh oh!

coderabbitai Bot commented Jul 20, 2026 •

edited

Loading

Walkthrough

Changes

Uh oh!

Uh oh!

coderabbitai Bot left a comment

Uh oh!

Uh oh!

Uh oh!

coderabbitai Bot left a comment

Uh oh!

Uh oh!

coderabbitai Bot left a comment

Uh oh!

coderabbitai Bot Jul 27, 2026

Uh oh!

Reviewers

Assignees

Labels

Milestone

Development

Uh oh!

2 participants

Search code, repositories, users, issues, pull requests...

Uh oh!

Uh oh!

Conversation

igorpecovnik commented Jul 20, 2026 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

coderabbitai Bot commented Jul 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Uh oh!

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

coderabbitai Bot Jul 27, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Milestone

Development

Uh oh!

2 participants

igorpecovnik commented Jul 20, 2026 •

edited by coderabbitai Bot

Loading

coderabbitai Bot commented Jul 20, 2026 •

edited

Loading