From 6f6b5df471e3317c6471f3e1e8bbe2ae9e4b39ec Mon Sep 17 00:00:00 2001 From: Matt Van Horn Date: Thu, 30 Apr 2026 02:30:34 -0700 Subject: [PATCH 1/2] docs: split From binary install steps into copy-paste-friendly blocks (#96) The current "From binary" install snippet is one large bash code block that mixes commands with `# ...` comments. Interactive zsh treats `#` as a literal token unless `setopt interactivecomments` is set, so a user who copies the whole block and pastes it gets stuck on an unmatched single quote ("GitHub's gh command"), which the issue reproduced. Following the format proposed in the issue (and accepted by jandubois), split each step into its own ```bash block with the explanatory comment moved out into surrounding prose. Each block is now independently copy-pasteable in zsh without needing interactivecomments enabled, and the prose continues to document what each step does. No commands changed; only the prose/code structure of the section. Fixes #96 Signed-off-by: Matt Van Horn Signed-off-by: Matt Van Horn <455140+mvanhorn@users.noreply.github.com> --- README.md | 22 ++++++++++++++++++---- 1 file changed, 18 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index bf16e19..1fb9ac8 100644 --- a/README.md +++ b/README.md @@ -43,20 +43,34 @@ Requires macOS 10.15 or later. ### From binary +Get the latest release version: + ```bash VERSION="$(curl -fsSL https://api.github.com/repos/lima-vm/socket_vmnet/releases/latest | jq -r .tag_name)" FILE="socket_vmnet-${VERSION:1}-$(uname -m).tar.gz" +``` -# Download the binary archive +Download the binary archive: + +```bash curl -OSL "https://github.com/lima-vm/socket_vmnet/releases/download/${VERSION}/${FILE}" +``` + +(Optional) Attest the GitHub Artifact Attestation using GitHub's [`gh`](https://cli.github.com) command: -# (Optional) Attest the GitHub Artifact Attestation using GitHub's gh command (https://cli.github.com) +```bash gh attestation verify --owner=lima-vm "${FILE}" +``` + +(Optional) Preview the contents of the binary archive: -# (Optional) Preview the contents of the binary archive +```bash tar tzvf "${FILE}" +``` + +Install `/opt/socket_vmnet` from the binary archive: -# Install /opt/socket_vmnet from the binary archive +```bash sudo tar Cxzvf / "${FILE}" opt/socket_vmnet ``` From 9da382f858667642c5e3a781179a8bb34bf2415c Mon Sep 17 00:00:00 2001 From: Matt Van Horn <455140+mvanhorn@users.noreply.github.com> Date: Sun, 19 Jul 2026 23:32:11 -0700 Subject: [PATCH 2/2] docs: keep binary install steps in one zsh-safe block Restore the single copy-paste block and prepend [ -n "$ZSH_VERSION" ] && setopt interactive_comments so the # comment lines work when pasted into zsh, as suggested in review. --- README.md | 24 ++++++------------------ 1 file changed, 6 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 1fb9ac8..00a6fce 100644 --- a/README.md +++ b/README.md @@ -43,34 +43,22 @@ Requires macOS 10.15 or later. ### From binary -Get the latest release version: - ```bash +[ -n "$ZSH_VERSION" ] && setopt interactive_comments + VERSION="$(curl -fsSL https://api.github.com/repos/lima-vm/socket_vmnet/releases/latest | jq -r .tag_name)" FILE="socket_vmnet-${VERSION:1}-$(uname -m).tar.gz" -``` - -Download the binary archive: -```bash +# Download the binary archive curl -OSL "https://github.com/lima-vm/socket_vmnet/releases/download/${VERSION}/${FILE}" -``` - -(Optional) Attest the GitHub Artifact Attestation using GitHub's [`gh`](https://cli.github.com) command: -```bash +# (Optional) Attest the GitHub Artifact Attestation using GitHub's gh command (https://cli.github.com) gh attestation verify --owner=lima-vm "${FILE}" -``` -(Optional) Preview the contents of the binary archive: - -```bash +# (Optional) Preview the contents of the binary archive tar tzvf "${FILE}" -``` - -Install `/opt/socket_vmnet` from the binary archive: -```bash +# Install /opt/socket_vmnet from the binary archive sudo tar Cxzvf / "${FILE}" opt/socket_vmnet ```