Skip to content

Commit 00d7383

Browse files
committed
README.md: add Homebrew
Signed-off-by: Akihiro Suda <[email protected]>
1 parent bc5b954 commit 00d7383

File tree

1 file changed

+19
-11
lines changed

1 file changed

+19
-11
lines changed

README.md

Lines changed: 19 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
[[⬇️ **Download]**](https://github.com/AkihiroSuda/lima/releases)
21
[[📖**Getting started]**](#getting-started)
32
[[**FAQs & Troubleshooting]**](#faqs--troubleshooting)
43

@@ -75,22 +74,32 @@ http://127.0.0.1:8080 is accessible from both macOS and Linux.
7574
For the usage of containerd and nerdctl (contaiNERD ctl), visit https://github.com/containerd/containerd and https://github.com/containerd/nerdctl.
7675

7776
## Getting started
78-
### Requirements (Intel Mac)
79-
- QEMU v6.0.0 or later (`brew install qemu`)
77+
### Installation
8078

81-
### Requirements (ARM Mac)
79+
[Homebrew package](https://github.com/Homebrew/homebrew-core/blob/master/Formula/lima.rb) is available for Intel Mac.
8280

83-
- QEMU with `--accel=hvf` support, see https://gist.github.com/nrjdalal/e70249bb5d2e9d844cc203fd11f74c55
81+
```console
82+
$ brew install lima
83+
```
8484

85-
> **NOTE**
86-
> Lima is not regularly tested on ARM Mac.
85+
<details>
86+
<summary>Manual installation steps (required for ARM Mac)</summary>
87+
<p>
88+
89+
- Install recent version of QEMU. v6.0.0 or later is recommended.
8790

88-
### Install
91+
- On ARM hosts, QEMU has to be patched for enabling `--accel=hvf` support. See https://gist.github.com/nrjdalal/e70249bb5d2e9d844cc203fd11f74c55
8992

90-
Download the binary archive from https://github.com/AkihiroSuda/lima/releases ,
93+
- Download the binary archive of Lima from https://github.com/AkihiroSuda/lima/releases ,
9194
and extract it under `/usr/local` (or somewhere else).
9295

93-
To install from the source, run `make && make install`.
96+
- To install Lima from the source, run `make && make install`.
97+
98+
> **NOTE**
99+
> Lima is not regularly tested on ARM Mac.
100+
101+
</p>
102+
</details>
94103

95104
### Usage
96105

@@ -163,7 +172,6 @@ The current default spec:
163172
:pray:
164173
- [Test on ARM Mac](https://github.com/AkihiroSuda/lima/issues/42)
165174
- Performance optimization
166-
- [Homebrew](https://github.com/AkihiroSuda/lima/issues/37)
167175
- More guest distros
168176
- Windows hosts
169177
- GUI with system tray icon (Qt or Electron, for portability)

0 commit comments

Comments
 (0)