Skip to content

Commit 91b5323

Browse files
committed
update docs
Signed-off-by: Akihiro Suda <[email protected]>
1 parent 08046f3 commit 91b5323

File tree

2 files changed

+6
-6
lines changed

2 files changed

+6
-6
lines changed

Diff for: README.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ It may work on NetBSD and Windows hosts as well.
2525

2626
✅ Intel on ARM
2727

28-
✅ Various guest Linux distributions: Ubuntu, Debian, Fedora, ...
28+
✅ Various guest Linux distributions: [Ubuntu](./examples/ubuntu.yaml), [Debian](./examples/debian.yaml), [Fedora](./examples/fedora.yaml), [Alpine](./examples/alpine.yaml), ...
2929

3030
Related project: [sshocker (ssh with file sharing and port forwarding)](https://github.com/AkihiroSuda/sshocker)
3131

@@ -209,18 +209,18 @@ Alternatively, you may also directly ssh into the guest: `ssh -p 60022 -o NoHost
209209
Yes, it should work, but not regularly tested on ARM.
210210

211211
#### "Can I run non-Ubuntu guests?"
212-
Fedora is also known to work, see [`./examples/fedora.yaml`](./examples/fedora.yaml).
213-
This file can be loaded with `limactl start ./examples/fedora.yaml`.
212+
Debian, Fedora, and Alpine are also known to work.
213+
See [`./examples/`](./examples/).
214214

215215
An image has to satisfy the following requirements:
216-
- systemd
216+
- systemd or OpenRC
217217
- cloud-init
218218
- The following binaries to be preinstalled:
219219
- `sudo`
220220
- The following binaries to be preinstalled, or installable via the package manager:
221221
- `sshfs`
222222
- `newuidmap` and `newgidmap`
223-
- `apt-get` or `dnf` (if you want to contribute support for another package manager, run `git grep apt-get` to find out where to modify)
223+
- `apt-get`, `dnf`, or `apk` (if you want to contribute support for another package manager, run `git grep apt-get` to find out where to modify)
224224

225225
#### "Can I run other container engines such as Podman?"
226226
Yes, if you install it.

Diff for: docs/internal.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Metadata:
1717
- `lima.yaml`: the YAML
1818

1919
cloud-init:
20-
- `cidata.iso`: cloud-init ISO9660 image. See [`cidata.iso`](#cidata-iso).
20+
- `cidata.iso`: cloud-init ISO9660 image. See [`cidata.iso`](#cidataiso).
2121

2222
disk:
2323
- `basedisk`: the base image

0 commit comments

Comments
 (0)