docs: refresh README (AI-assisted)#167
Open
igorpecovnik wants to merge 1 commit into
Open
Conversation
igorpecovnik
force-pushed
the
chore/update-readme
branch
from
July 24, 2026 14:33
841df49 to
cc5421b
Compare
There was a problem hiding this comment.
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 on lines
+146
to
+150
| | Requirement | Minimum | | ||
| |-------------|---------| | ||
| | Node.js | 20.19.0 | | ||
| | Rust | 1.85 | | ||
| | npm | 10+ | |
| | 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. |
igorpecovnik
force-pushed
the
chore/update-readme
branch
from
July 24, 2026 14:53
cc5421b to
bb86656
Compare
There was a problem hiding this comment.
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.zipin the release workflow, not a raw.appbundle, 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-ignoreinmaintenance-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
.appbundle and uploads it as.app.zip, so this list should reference.app.ziprather than.app.
- **`maintenance-release.yml`** — Tag-driven release pipeline that produces `.deb`, `.AppImage`, `.dmg`, `.app`, and Windows installers with Tauri updater signatures
| - **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` |
| - 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 |
|
|
||
| ### 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: |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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).