Skip to content

Commit 7d9ecde

Browse files
committed
Point install guidance to official docs pages
1 parent 45548b0 commit 7d9ecde

3 files changed

Lines changed: 29 additions & 47 deletions

File tree

README.md

Lines changed: 8 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -37,30 +37,16 @@ Docker containers share the host kernel. Gondolin runs workloads inside a VM, so
3737

3838
## Requirements
3939

40-
- Bun >= 1.2
41-
- `e2fsprogs` (`mke2fs`, `debugfs`)
42-
- QEMU (for runtime smoke checks)
43-
- Docker (only required for `dockerfile2gondolin`)
40+
- Bun >= 1.2https://bun.com/
41+
- `e2fsprogs` (`mke2fs`, `debugfs`)https://e2fsprogs.sourceforge.net/
42+
- QEMU (for runtime smoke checks)https://www.qemu.org/download/
43+
- Docker (only required for `dockerfile2gondolin`)https://docs.docker.com/get-docker/
4444

4545
`docker2vm` uses `@earendil-works/gondolin@0.2.1` as a runtime dependency and resolves/downloads guest assets automatically during conversion.
4646

47-
If you also want to run generated assets with `gondolin exec`, install the CLI separately:
48-
49-
```bash
50-
bun add -g @earendil-works/gondolin@0.2.1
51-
```
52-
53-
macOS helpers:
54-
55-
```bash
56-
brew install e2fsprogs qemu
57-
```
58-
59-
Ubuntu helpers:
60-
61-
```bash
62-
sudo apt-get install -y e2fsprogs qemu-system-x86
63-
```
47+
If you also want to run generated assets with `gondolin exec`, install the Gondolin CLI:
48+
- CLI docs: https://earendil-works.github.io/gondolin/cli/
49+
- Package: https://www.npmjs.com/package/@earendil-works/gondolin
6450

6551
> On macOS, `docker2vm` checks common Homebrew `e2fsprogs` locations automatically; updating `PATH` is usually optional.
6652
@@ -93,7 +79,7 @@ The CI integration matrix currently validates:
9379
- `fedora:41`
9480
- `archlinux:latest`
9581

96-
For each distro row, tests run a distro-specific probe command (for example `/etc/debian_version`, `/etc/fedora-release`, etc.) and also assert that probe does **not** match on the base Gondolin guest image.
82+
For each distro row, tests run a distro-specific probe command (for example `/etc/debian_version`, `/etc/fedora-release`, etc.), assert that probe does **not** match on the base Gondolin guest image, and verify `/bin/busybox` executes inside the converted image.
9783

9884
### Choosing the build platform (`--platform`)
9985

docs/linux.md

Lines changed: 10 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -6,32 +6,25 @@ This guide is for running `docker2vm` on Linux hosts.
66

77
## 1) Install required tools
88

9-
### Ubuntu / Debian
9+
Install tools using their official docs/download pages:
1010

11-
```bash
12-
sudo apt-get update
13-
sudo apt-get install -y curl unzip e2fsprogs qemu-system-x86
14-
```
11+
- Bun: https://bun.com/
12+
- QEMU: https://www.qemu.org/download/
13+
- e2fsprogs: https://e2fsprogs.sourceforge.net/
1514

16-
Install Bun:
15+
If you want Dockerfile conversion (`dockerfile2gondolin`), also install Docker + Buildx:
1716

18-
```bash
19-
curl -fsSL https://bun.sh/install | bash
20-
export BUN_INSTALL="$HOME/.bun"
21-
export PATH="$BUN_INSTALL/bin:$PATH"
22-
```
23-
24-
If you want Dockerfile conversion (`dockerfile2gondolin`), install Docker and Buildx.
17+
- Docker: https://docs.docker.com/get-docker/
18+
- Buildx: https://docs.docker.com/build/buildx/install/
2519

2620
## 2) Optional: install Gondolin CLI (for running generated assets)
2721

2822
`docker2vm` is tested with `@earendil-works/gondolin@0.2.1` and can fetch guest assets automatically during conversion.
2923

30-
Install the CLI globally if you want to execute generated assets via `gondolin exec`:
24+
Use Gondolin CLI install docs:
3125

32-
```bash
33-
bun add -g @earendil-works/gondolin@0.2.1
34-
```
26+
- https://earendil-works.github.io/gondolin/cli/
27+
- Package page: https://www.npmjs.com/package/@earendil-works/gondolin
3528

3629
## 3) Verify toolchain
3730

docs/macos.md

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,14 @@ This guide is for running `docker2vm` on macOS (Apple Silicon or Intel).
66

77
## 1) Install required tools
88

9-
```bash
10-
brew install bun qemu e2fsprogs
11-
```
9+
Install tools using their official docs/download pages:
10+
11+
- Bun: https://bun.com/
12+
- QEMU: https://www.qemu.org/download/
13+
- e2fsprogs: https://e2fsprogs.sourceforge.net/
1214

13-
If you want Dockerfile conversion (`dockerfile2gondolin`), also install Docker Desktop.
15+
If you want Dockerfile conversion (`dockerfile2gondolin`), also install Docker Desktop:
16+
- https://docs.docker.com/desktop/setup/install/mac-install/
1417

1518
## 2) Optional: add `e2fsprogs` binaries to `PATH`
1619

@@ -28,11 +31,11 @@ To persist it, add that `export PATH=...` line to your shell profile (`~/.zshrc`
2831

2932
`docker2vm` is tested with `@earendil-works/gondolin@0.2.1` and can fetch guest assets automatically during conversion.
3033

31-
Install the CLI globally if you want to execute generated assets via `gondolin exec`:
34+
Gondolin CLI docs:
35+
- https://earendil-works.github.io/gondolin/cli/
3236

33-
```bash
34-
bun add -g @earendil-works/gondolin@0.2.1
35-
```
37+
Package page:
38+
- https://www.npmjs.com/package/@earendil-works/gondolin
3639

3740
## 4) Verify toolchain
3841

0 commit comments

Comments
 (0)