Terminal Markdown previewer — GUI-like experience.
Merge pull request #18 from RivoLink/docs/leaf-update-guides
docs: leaf update guides
+20
-8
+20
-8
README.md
+20
-8
README.md
···
6
6
Terminal Markdown previewer — GUI-like experience.
7
7
</p>
8
8
9
-
## Install or update
9
+
## Install
10
10
11
-
Install or update to the latest published binary.
11
+
Install the latest published binary.
12
12
13
13
macOS / Linux / Android / Termux:
14
14
···
28
28
leaf --version
29
29
```
30
30
31
+
## Update
32
+
33
+
Update an existing installation to the latest published release:
34
+
35
+
```bash
36
+
leaf --update
37
+
```
38
+
39
+
`leaf --update` downloads the matching published asset, verifies it against the published `checksums.txt` SHA256, and then installs it.
40
+
41
+
On Windows, if replacing the running `.exe` is blocked by the OS, rerun the PowerShell installer from the install section.
42
+
31
43
## Build
32
44
33
45
Clone the repository:
···
76
88
# Open the file picker in the current directory
77
89
leaf
78
90
79
-
# Update to the latest published version
80
-
leaf --update
81
91
```
82
92
83
93
## Keybindings
···
146
156
147
157
For `leaf-windows-x86_64.exe`, the relevant package is the latest supported **X64** Visual C++ v14 Redistributable.
148
158
149
-
### Windows: `leaf --update`
159
+
### Windows: update or file replacement error
150
160
151
-
`leaf --update` verifies the downloaded binary against the published `checksums.txt` SHA256 before installation.
161
+
If `leaf --update` fails on Windows with an error about replacing, renaming, or writing `leaf.exe`, the running executable was likely locked by the OS.
152
162
153
-
On Unix-like systems, it then replaces the current binary in place.
163
+
Close any terminal session still running `leaf`, then rerun the PowerShell installer from the install section:
154
164
155
-
On Windows, replacing the running `.exe` can be blocked by the OS. If `leaf --update` cannot complete there, rerun the PowerShell installer from the install section.
165
+
```powershell
166
+
irm https://raw.githubusercontent.com/RivoLink/leaf/main/scripts/install.ps1 | iex
167
+
```