From 48ea12ed7a0f273cf9154b4b3e3aeb2ce5e5add0 Mon Sep 17 00:00:00 2001
From: Alexandre Pasmantier <47638216+alexpasmantier@users.noreply.github.com>
Date: Tue, 26 Nov 2024 21:09:59 +0100
Subject: [PATCH] docs(install): update the installation section of the README
(#79)
---
README.md | 89 ++++++++++++++++++++++++++++++++++++-------------------
1 file changed, 59 insertions(+), 30 deletions(-)
diff --git a/README.md b/README.md
index 0a3c080..2d7fd2b 100644
--- a/README.md
+++ b/README.md
@@ -22,41 +22,70 @@ It is inspired by the neovim [telescope](https://github.com/nvim-telescope/teles
## Installation
-#### MacOS
-```bash
-brew install alexpasmantier/television/television
-```
+
+MacOS
+
+ ```bash
+ brew install alexpasmantier/television/television
+ ```
-#### Debian-based (Debian, Ubuntu, Pop!_OS, Linux Mint, etc.)
-```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
-```
-#### Arch Linux
-```bash
-pacman -S television
-```
+
+
+
+ Arch Linux
+
-#### Cross-Platform from `conda-forge`
-```bash
-pixi global install television
-```
+ ```bash
+ pacman -S television
+ ```
-#### Binary ([latest release](https://github.com/alexpasmantier/television/releases/latest))
-- 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)
+
+
+
+ Debian-based (Debian, Ubuntu, Pop!_OS, Linux Mint, etc.)
+
+
+ ```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
+ ```
+
+
+
+
+ Conda-forge (cross-platform)
+
+
+ ```bash
+ pixi global install television
+ ```
+
+
+
+ Binary
+
+
+ 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)
+
+
+
+ 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
+ ```
+
-#### 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
```bash
tv [channel] #[default: files] [possible values: env, files, git-repos, text, alias]