organized README

This commit is contained in:
Valerie Wolfe 2024-02-22 14:11:26 -05:00
parent 7942f7b035
commit 33fc042fb6

View file

@ -12,25 +12,39 @@ slant symbols, and therefore require use of a Powerline font, such as [Fira Code
## Installation
### From Binary
### Manual Install
Copy the compiled binary from the [releases page](https://git.vwolfe.io/valerie/pride/releases)
to a directory in `$PATH`, such as `/usr/bin/`.
<details>
<summary>From Binary</summary>
Copy the compiled binary from the <a href="https://git.vwolfe.io/valerie/pride/releases/">releases page</a>
to a directory in <code>$PATH</code>, such as <code>/usr/bin/</code>.
</details>
### From Source
<details>
<summary>Compile from Source</summary>
Compile using cargo with the command <code>cargo build --release</code> and
copy the file from <code>target/release/</code> to a directory in
<code>$PATH</code>, such as <code>/usr/bin/</code>.
</details>
Compile using cargo with the command `cargo build --release` and copy the file
from `target/release/` to a directory in `$PATH`, such as `/usr/bin/`.
<details>
<summary>makepkg (AUR)</summary>
Clone the <a href="https://aur.archlinux.org/pride.git">AUR Repository</a> and
run the command <code>makepkg --install</code>
</details>
### Cargo
### Package Managers
Install the package from cargo using `cargo install pride-term`.
<details>
<summary>Arch Linux (AUR): <code>pride</code></summary>
Install the package from the <a href="https://aur.archlinux.org/packages/pride"><code>pride</code> AUR Package</a>
using an AUR package manager such as <a href="https://github.com/Morganamilo/paru"><code>paru</code></a>
</details>
### Arch Linux (AUR)
Install the package from the [`pride` AUR Package](https://aur.archlinux.org/packages/pride),
either using an AUR package manager, or by cloning the [AUR Repository](https://aur.archlinux.org/pride.git)
and running the command `makepkg --install`.
<details>
<summary>Cargo: <code>pride-term</code></summary>
Install the package using Cargo with the command <code>cargo install pride-term</code>.
</details>
## Libraries