Skip to content

docs: document build prerequisites and how to run the UI - #10

Open
h2m6jcm94s-eng wants to merge 1 commit into
bottlesdevs:mainfrom
h2m6jcm94s-eng:docs/dev-setup
Open

h2m6jcm94s-eng wants to merge 1 commit into
bottlesdevs:mainfrom
h2m6jcm94s-eng:docs/dev-setup

Conversation

@h2m6jcm94s-eng

Copy link
Copy Markdown

Summary

Following the README on a fresh Ubuntu 26.04 machine (git clone --recursive, then just build) runs into errors the README doesn't mention:

  1. WineBridge: can't find crate for std, because the x86_64-pc-windows-gnu target isn't installed. With the target installed, it then fails on x86_64-w64-mingw32-dlltool because MinGW is missing.
  2. Boot: the UI and CLI fail with Fvs(Io(NotFound)) because fvs2d isn't on PATH. Nothing in the repo says how to get it.

This PR adds:

  • rust-toolchain.toml: rustup installs the Windows target, clippy and rustfmt automatically on first use. The channel stays stable, matching the flake.
  • just fvs2d: builds the daemon from the vendored crates/fvs2-rs/upstream sources into $CARGO_HOME/bin, so it's on PATH for rustup users.
  • just run: runs the UI. Arguments are forwarded, so just run --no-default-features runs it without Virgo.
  • README: prerequisites, with package lists for Debian/Ubuntu and Fedora, plus how to run the UI and a note on the disk space a debug build needs.

Related: bottlesdevs/next-core#58 makes the missing-fvs2d error name the daemon. bottlesdevs/next-ui#6 and #9 fix the next-ui compile errors on main.

Testing

  • just fvs2d builds and installs the daemon with Go 1.27.
  • With the daemon installed, bottles-cli profiles list boots and next-ui starts.
  • rustup installs the target from rust-toolchain.toml.
  • The apt list is checked against Ubuntu 26.04 candidates. I have not tested the Fedora list.

Generative AI assistance

AI assistance: disclosed

🤖 Generated with Claude Code

A fresh checkout hits three errors the README never mentions:
WineBridge needs the x86_64-pc-windows-gnu target and MinGW, and the UI
and CLI fail at boot unless fvs2d is on PATH.

- rust-toolchain.toml makes rustup install the Windows target on demand.
- `just fvs2d` builds the daemon from the vendored fvs2d sources into
  cargo's bin directory; `just run` starts the UI.
- The README lists the system packages for Debian/Ubuntu and Fedora,
  the no-fvs fallback, and the disk space a debug build needs.

Assisted-by: Claude Code:claude-opus-5-5
AI-Scope: README prerequisites, justfile recipes and rust-toolchain.toml, from setup failures hit on a fresh Ubuntu machine ("make prs so that no one faces errors"); recipes verified locally.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants