doc: Add install guide instructions.
Some checks failed
CI / Lint (push) Has been cancelled
CI / Test (push) Has been cancelled

This commit is contained in:
2026-03-14 12:50:27 -04:00
parent c6d80a9650
commit f6f1efdf8e
4 changed files with 408 additions and 0 deletions

View File

@@ -95,6 +95,30 @@ or at all:
overlay on Wayland (layer-shell) and X11. Auto-detects your
environment.
## Install
See [docs/guides/install.md](docs/guides/install.md) for full details.
The short version:
```sh
cargo install pikl
```
Or from source:
```sh
git clone https://github.com/maplecool/pikl-menu.git
cd pikl-menu
cargo install --path .
```
## Guides
- **[Install](docs/guides/install.md):** cargo install, building from source
- **[App Launcher](docs/guides/app-launcher.md):** set up pikl as a
keyboard-driven app launcher on Hyprland, i3, macOS (Raycast), or
in a terminal
## Building
```sh