From 33fc042fb69e6b9f1b70d330c8999f797f0b0a56 Mon Sep 17 00:00:00 2001 From: Valerie Date: Thu, 22 Feb 2024 14:11:26 -0500 Subject: [PATCH] organized README --- README.md | 40 +++++++++++++++++++++++++++------------- 1 file changed, 27 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 3315bfa..8b20ae7 100644 --- a/README.md +++ b/README.md @@ -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/`. +
+From Binary +Copy the compiled binary from the releases page +to a directory in $PATH, such as /usr/bin/. +
-### From Source +
+Compile from Source +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/. +
-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/`. +
+makepkg (AUR) +Clone the AUR Repository and +run the command makepkg --install +
-### Cargo +### Package Managers -Install the package from cargo using `cargo install pride-term`. +
+Arch Linux (AUR): pride +Install the package from the pride AUR Package +using an AUR package manager such as paru +
-### 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`. +
+Cargo: pride-term +Install the package using Cargo with the command cargo install pride-term. +
## Libraries