Skip to content

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

Open
igorpecovnik wants to merge 1 commit into
mainfrom
chore/update-readme
Open

docs: refresh README (AI-assisted)#167
igorpecovnik wants to merge 1 commit into
mainfrom
chore/update-readme

Conversation

@igorpecovnik

@igorpecovnik igorpecovnik commented Jul 20, 2026

Copy link
Copy Markdown
Member

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).

@igorpecovnik igorpecovnik added the documentation Improvements or additions to documentation label Jul 20, 2026
@igorpecovnik
igorpecovnik force-pushed the chore/update-readme branch from 841df49 to cc5421b Compare July 24, 2026 14:33
Copilot AI review requested due to automatic review settings July 24, 2026 14:33

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates the repository’s README to reflect the current Armbian Imager scope, architecture, and contributor workflow, aligning the top-level documentation with the project’s present-day Tauri/Rust/React implementation and CI/release automation.

Changes:

  • Rewrites the introduction and feature list with more concrete capabilities (updater, autoconfig injection, QDL path).
  • Adds new contributor-oriented sections (Tech Stack, Repository Layout, Development quick start, CI workflow summary).
  • Clarifies downloads, platform support, and licensing information (including dual licensing for the in-repo crate).

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread README.md Outdated
Comment on lines +146 to +150
| Requirement | Minimum |
|-------------|---------|
| Node.js | 20.19.0 |
| Rust | 1.85 |
| npm | 10+ |
Comment thread README.md Outdated
| Rust | 1.85 |
| npm | 10+ |

Platform packages (Linux): `libglib2.0-dev libgtk-3-dev libwebkit2gtk-4.1-dev libayatana-appindicator3-dev librsvg2-dev`. On macOS you need Xcode Command Line Tools; on Windows, Visual Studio Build Tools 2022 + the WebView2 Runtime.
Copilot AI review requested due to automatic review settings July 24, 2026 14:53
@igorpecovnik
igorpecovnik force-pushed the chore/update-readme branch from cc5421b to bb86656 Compare July 24, 2026 14:53

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 3 comments.

Comments suppressed due to low confidence (3)

README.md:49

  • The macOS downloadable artifact is uploaded as .app.zip in the release workflow, not a raw .app bundle, so the table should reflect the actual filename users will see.
| `.dmg` / `.app` | `.exe` / `.msi` | `.deb` / `.AppImage` |

README.md:177

  • This workflow is skipped for docs-only / ignored-path PRs due to paths-ignore in maintenance-pr-check.yml, so “on every pull request” is not strictly correct.
- **`maintenance-pr-check.yml`** — Frontend lint/type-check, Rust fmt/clippy, and cross-platform build tests (Linux x64, Windows x64, macOS ARM) on every pull request

README.md:179

  • The release workflow zips the macOS .app bundle and uploads it as .app.zip, so this list should reference .app.zip rather than .app.
- **`maintenance-release.yml`** — Tag-driven release pipeline that produces `.deb`, `.AppImage`, `.dmg`, `.app`, and Windows installers with Tauri updater signatures

Comment thread README.md Outdated
- **Frontend:** TypeScript, React 19, Vite 8, i18next, `lucide-react`
- **Backend:** Rust (edition 2021, MSRV 1.85), Tokio async runtime
- **Bundled Rust crates:** `reqwest` (rustls), `sha2`, `xz2` / `lzma-rust2` / `bzip2` / `flate2` / `zstd` for image decompression, `qdl` for Qualcomm EDL flashing, `nusb`, `udisks2` + `zbus` on Linux, `security-framework` on macOS, `windows-sys` on Windows
- **Tauri plugins:** `shell`, `dialog`, `updater`, `process`, `store`, `fs`
Comment thread README.md Outdated
- Multi-language interface that follows your system language by default
- Built-in application updates
- Small binary with few runtime dependencies
- Native builds for Linux (`.deb`, `.AppImage`), Windows (`.exe`/`.msi`), and macOS (`.dmg`, `.app`) on x64 and ARM64
Comment thread README.md Outdated

### Quality checks

CI (see [`.github/workflows/maintenance-pr-check.yml`](.github/workflows/maintenance-pr-check.yml)) runs the following on every PR — please run them locally first:
Copilot AI review requested due to automatic review settings July 27, 2026 08:49
@igorpecovnik
igorpecovnik force-pushed the chore/update-readme branch from bb86656 to dd24ae9 Compare July 27, 2026 08:49

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 2 comments.

Comments suppressed due to low confidence (1)

README.md:129

  • "A stable Rust toolchain" is a bit ambiguous given the repo declares rust-version = 1.85.0 (minimum supported Rust). Calling out the minimum version explicitly makes the requirement actionable for contributors using distro-packaged Rust or pinned toolchains.
Requirements: Node.js ≥ 20.19.0 and a stable Rust toolchain.

Comment thread README.md Outdated
- Multi-language interface that follows your system language by default
- Built-in application updates
- QDL (Qualcomm Device Loader) flashing support for EDL-based boards (e.g. Arduino UNO Q)
- First-boot autoconfig injection into the ext4 rootfs of downloaded images
Comment thread README.md
Comment on lines +123 to +126
git clone https://github.com/armbian/imager.git && cd imager
bash scripts/setup/install.sh
npm install
npm run tauri:dev
Copilot AI review requested due to automatic review settings August 3, 2026 08:47

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 Not ready to approve

The updated README contains several verified factual inaccuracies/misleading statements (artifact formats, Tauri plugin list, CI “every PR” claim, and updater platform coverage) that should be corrected before merging.

Once you've addressed the issues Copilot identified, you can request another Copilot review.

This review doesn't count toward merge requirements. Sign up for the private preview to control whether Copilot approvals count.

Review details

Suppressed comments (5)

README.md:28

  • macOS release artifacts are published as .app.zip (and updater .tar.gz), not a raw .app bundle. Listing .app here may confuse users because GitHub Releases won’t offer a bare .app download.
| `.dmg` / `.app` | `.exe` (NSIS) / `.msi` | `.deb` / `.AppImage` |

README.md:57

  • The README lists the fs plugin, but the app only initializes shell/dialog/process/store (+ updater) in src-tauri/src/main.rs. If the FS plugin isn’t actually registered, it shouldn’t be documented as part of the active plugin set.
- **Desktop shell:** [Tauri 2](https://tauri.app/) with the `shell`, `dialog`, `updater`, `process`, `store`, and `fs` plugins

README.md:149

  • The PR-check workflow is configured with paths-ignore (e.g. **.md, .github/**), so these checks do not run on every PR. Consider rewording to avoid promising CI coverage where it won’t execute.
CI runs these on every PR, so run them locally first:

README.md:8

  • The description reads like the flashing happens "on" the single-board computer, but the app runs on a desktop and flashes media for use in an SBC. Reword to avoid implying the SBC is the flashing host.
Armbian Imager is the official desktop tool for downloading and flashing Armbian OS images to SD cards and USB drives on single-board computers. It performs disk safety checks before writing, validates the download checksum, and verifies the image after the write, so a bad download or the wrong disk doesn't turn into a broken card.

README.md:16

  • The updater is intentionally disabled on Linux when not running as an AppImage, so this bullet overstates platform coverage. Consider clarifying which platforms/formats support in-app updates.
- Built-in application updates via Tauri updater
  • Files reviewed: 1/1 changed files
  • Comments generated: 0 new
  • Review effort level: Lite

We're testing this review assessment. Please use 👍 or 👎 to tell us if it's correct.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants