Skip to content

Commit 81fead9

Browse files
committed
docs: add one-paste Linux/Windows binary install blocks
1 parent 033f0da commit 81fead9

2 files changed

Lines changed: 34 additions & 9 deletions

File tree

CHANGELOG.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,9 @@ Distribution and release-pipeline fixes.
2323

2424
### Added
2525
- Homebrew tap `tamirelazar/homebrew-tslime` (source build).
26+
- One-paste install blocks for Linux and Windows in the README: they fetch the
27+
latest release binary, install it to a user directory, put it on `PATH`, and
28+
(on Windows) clear the Mark-of-the-Web so SmartScreen stays quiet.
2629

2730
## [0.1.0] - 2026-06-26
2831

README.md

Lines changed: 31 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -25,19 +25,41 @@ and sidesteps macOS Gatekeeper entirely.
2525
brew install tamirelazar/tslime/tslime
2626
```
2727

28-
### Linux / Windows — prebuilt binary
28+
### Linux — prebuilt binary
2929

30-
Download from the [latest release](https://github.com/tamirelazar/tslime/releases/latest):
30+
The Linux binary is statically linked (musl) and runs on any x86_64 distribution.
31+
Paste this to install it to `~/.local/bin`:
3132

32-
- **Linux**`tslime-linux-x86_64` is statically linked and runs on any x86_64
33-
Linux distribution:
33+
```bash
34+
mkdir -p ~/.local/bin
35+
curl -fsSL https://github.com/tamirelazar/tslime/releases/latest/download/tslime-linux-x86_64 -o ~/.local/bin/tslime
36+
chmod +x ~/.local/bin/tslime
37+
~/.local/bin/tslime --version
38+
```
39+
40+
If `tslime` isn't found afterwards, add `~/.local/bin` to your `PATH`:
3441

35-
```bash
36-
chmod +x tslime-linux-x86_64 && ./tslime-linux-x86_64
37-
```
42+
```bash
43+
echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.profile && export PATH="$HOME/.local/bin:$PATH"
44+
```
45+
46+
### Windows — prebuilt binary
47+
48+
Paste this into **PowerShell**. It downloads the binary, clears the
49+
Mark-of-the-Web so SmartScreen stays quiet, and adds it to your `PATH`:
50+
51+
```powershell
52+
$dir = "$env:LOCALAPPDATA\Programs\tslime"
53+
New-Item -ItemType Directory -Force -Path $dir | Out-Null
54+
Invoke-WebRequest "https://github.com/tamirelazar/tslime/releases/latest/download/tslime-windows-x86_64.exe" -OutFile "$dir\tslime.exe"
55+
Unblock-File "$dir\tslime.exe"
56+
$userPath = [Environment]::GetEnvironmentVariable("Path", "User")
57+
if ($userPath -notlike "*$dir*") { [Environment]::SetEnvironmentVariable("Path", "$userPath;$dir", "User") }
58+
& "$dir\tslime.exe" --version
59+
```
3860

39-
- **Windows**`tslime-windows-x86_64.exe`. SmartScreen may warn about the
40-
unsigned executable; click **More info → Run anyway**.
61+
Open a new terminal afterwards so the `PATH` change takes effect (or run
62+
`$env:Path += ";$dir"` in the current one), then just run `tslime`.
4163

4264
> macOS prebuilt binaries are not published — use Homebrew or `cargo install`
4365
> (both avoid Gatekeeper). ARM Linux (aarch64): use `cargo install`.

0 commit comments

Comments
 (0)