Skip to content

Explain the apt install line of the README example and run it first - #54

Merged
linghengqian merged 1 commit into
mainfrom
docs/system-packages
Nov 3, 2026
Merged

linghengqian merged 1 commit into
mainfrom
docs/system-packages

Conversation

@linghengqian

Copy link
Copy Markdown
Member
  • README.md and README_CN.md: the example installs the system packages first, and a paragraph under it says what that line is: not a vfox command, the packages that Flutter's installation guide asks for on Linux, written for apt (Ubuntu and other Debian-based distributions), and different on every system. It links to the new section below.
  • docs/platforms.md and docs/zh-CN/platforms.md: a new "System packages" section.
    • Where the command comes from: the Linux part of Flutter's Install Flutter manually guide, which gives apt-get as its example. The README uses apt and --assume-yes and has no apt-get update line, so the section says to update the package lists in a fresh container.
    • What each part of the line means, and what Flutter uses each of the six packages for.
    • What other systems need: other Linux distributions, macOS and Windows.
    • Why the packages come before vfox install.
  • The "Flutter's own tools" bullet of platforms.md points to the section instead of listing the packages.

Why the order of the example changed

lib/manifest.lua reads the SDK's commit with git rev-parse HEAD when it installs. Without git, the source installs (Linux ARM64, Windows ARM64, OpenHarmony builds) fail, and any other install succeeds with a .vfox-manifest that has no commit, so the drift check of flutter-upgrade.md never warns. The example used to run apt install after vfox install.

Checked

  • In a fresh ubuntu:26.04 container the README line fails without apt update (Unable to locate package curl) and installs all six packages after it.
  • What each package is for comes from Flutter's bin/internal/shared.sh (git), bin/internal/update_dart_sdk.sh (curl, unzip) and OperatingSystemUtils.unzip of the Flutter tool, and from vfox's decompressor.go, which unpacks .tar.xz itself, so xz-utils is there for Flutter's manual steps. Flutter's current guide does not say why zip and libglu1-mesa are listed. Its 2023 and 2024 versions (Wayback copies) list zip among the tools Flutter relies on, and say that flutter test needs libGLU.so.1, which mesa-libGLU provides on Fedora. The section words these as "earlier versions of Flutter's guide".
  • The #download-prerequisites anchor exists on docs.flutter.dev and docs.flutter.cn, the Git for Windows link answers, and the links to the new heading resolve in both languages. The English and Chinese sections have the same structure.
  • Docs only, so no changes.md entry: it lists what users notice of a release.

…irst

The README example installs curl, git, unzip, xz-utils, zip and libglu1-mesa
with apt, and did not say where the line comes from or that it is different on
every system.

- README.md, README_CN.md: install the packages first, because the plugin
  runs git while it installs, and add a paragraph that explains the line.
- docs/platforms.md, docs/zh-CN/platforms.md: a "System packages" section with
  the source of the command (Flutter's "Install Flutter manually" guide), what
  each package is for, why they come before `vfox install`, and what other
  systems need.
@linghengqian linghengqian added the documentation Improvements or additions to documentation label Nov 3, 2026
@linghengqian
linghengqian merged commit f026961 into main Nov 3, 2026
10 checks passed
@linghengqian
linghengqian deleted the docs/system-packages branch November 3, 2026 05:52
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.

1 participant