docs(install): update the installation section of the README (#79)

This commit is contained in:
Alexandre Pasmantier 2024-11-26 21:09:59 +01:00 committed by GitHub
parent a46d6f8510
commit 48ea12ed7a
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -22,41 +22,70 @@ It is inspired by the neovim [telescope](https://github.com/nvim-telescope/teles
## Installation ## Installation
#### MacOS <details>
```bash <summary>MacOS</summary>
brew install alexpasmantier/television/television
```
#### Debian-based (Debian, Ubuntu, Pop!_OS, Linux Mint, etc.) ```bash
```bash brew install alexpasmantier/television/television
curl -LO https://github.com/alexpasmantier/television/releases/download/0.5.2/television_0.5.2-1_amd64.deb ```
sudo dpkg -i television_0.5.2-1_amd64.deb
```
#### Arch Linux
```bash
pacman -S television
```
#### Cross-Platform from `conda-forge` </details>
```bash <details>
pixi global install television <summary>
``` Arch Linux
</summary>
#### Binary ([latest release](https://github.com/alexpasmantier/television/releases/latest)) ```bash
- Download the latest release asset for your platform (e.g. `tv-vX.X.X-linux-x86_64.tar.gz` if you're on a linux x86 machine) pacman -S television
- Unpack and copy to the relevant location on your system (e.g. `/usr/local/bin` on macos and linux for a global installation) ```
</details>
<details>
<summary>
Debian-based (Debian, Ubuntu, Pop!_OS, Linux Mint, etc.)
</summary>
```bash
curl -LO https://github.com/alexpasmantier/television/releases/download/0.5.2/television_0.5.2-1_amd64.deb
sudo dpkg -i television_0.5.2-1_amd64.deb
```
</details>
<details>
<summary>
Conda-forge (cross-platform)
</summary>
```bash
pixi global install television
```
</details>
<details>
<summary>
Binary
</summary>
From the [latest release](https://github.com/alexpasmantier/television/releases/latest) page:
- Download the latest release asset for your platform (e.g. `tv-vX.X.X-linux-x86_64.tar.gz` if you're on a linux x86 machine)
- Unpack and copy to the relevant location on your system (e.g. `/usr/local/bin` on macos and linux for a global installation)
</details>
<details>
<summary>
Cargo
</summary>
Setup the latest stable Rust toolchain via rustup:
```bash
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
rustup update
```
Install `television`:
```bash
cargo install --locked television
```
</details>
#### From source using `cargo`:
Setup the latest stable Rust toolchain via rustup:
```bash
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
rustup update
```
Install `television`:
```bash
cargo install --locked television
```
## Usage ## Usage
```bash ```bash
tv [channel] #[default: files] [possible values: env, files, git-repos, text, alias] tv [channel] #[default: files] [possible values: env, files, git-repos, text, alias]