From d42f2059fd40bb0ef050a5ce360332022743f2f1 Mon Sep 17 00:00:00 2001 From: Michal S Date: Sun, 21 Aug 2022 15:08:47 +0100 Subject: [PATCH] Args and readme cleanup --- README.md | 41 ++++++++++++++++++++--------------------- src/args.rs | 2 +- src/main.rs | 9 ++++++++- 3 files changed, 29 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index dadba6e..d060ebd 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ GitHub isses GitHub pull requests
Discord - The
+ The
Mastodon Follow Twitter Follow @@ -25,30 +25,33 @@ Made for Crystal, compatible with any Arch-based Linux distribution. ### Basic usage -| Action | FreeBSD pkg-style alias | Pacman-style flags | -|----------------------|-------------------------|--------------------| -| Install a package | ame ins/install | ame -S | -| Remove a package | ame rm/remove | ame -R/-Rs | -| Upgrade a package | ame upg/upgrade | ame -Syu | -| Search for a package | ame sea | ame -Ss | +| Action | FreeBSD pkg-style alias | Pacman-style flags | +|------------------------|-------------------------|--------------------| +| Install a package | ame ins/install | ame -S | +| Remove a package | ame rm/remove | ame -R/-Rs | +| Upgrade a package | ame upg/upgrade | ame -Syu | +| Search for a package | ame sea/search | ame -Ss | +| Query the package list | ame qu/query | ame -Q | +| Show a package's info | ame inf/info | ame -Qi | + | Clean the pacman cache | ame cl/clean | ame -Sc | +| Check for .pacnew | ame di/diff | ame -D | ### Exit codes overview | Exit Code (i32) | Reason | |-----------------|----------------------------------------------------------| | 1 | Running ame as UID 0 / root | -| 2 | Failed adding package to database | -| 3 | Failed initialising database | -| 4 | Error creating cache and/or database paths | -| 5 | Could not find one or more required package dependencies | -| 6 | User cancelled package installation | -| 7 | Pacman error when installing package | -| 8 | Git error | -| 9 | makepkg error | +| 2 | Failed creating paths | +| 3 | Could not find one or more required package dependencies | +| 4 | User cancelled package installation | +| 5 | Pacman error when installing package | +| 6 | Git error | +| 7 | Makepkg error | +| 63 | Any other misc error | ### How to build: -Tested on latest Cargo (1.60.0-nightly) +Tested on latest Cargo (1.62.0-nightly)
@@ -60,14 +63,10 @@ Tested on latest Cargo (1.60.0-nightly) - `cargo build --release` -#### Pkg-warner included - -- `cargo build (--release) --all --features=pkg-warner` - ### TODO: #### v3.6.0 -- Allow editing of PKGBUILDs before install +- ~~Allow editing of PKGBUILDs before install~~