diff --git a/README.md b/README.md index 273b6d3..59cd16e 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,87 @@ # pkm -**P**ac**K**age**M**anager - Simple apt-style [Yay](https://github.com/Jguer/yay) wrapper +**P**ac**K**age**M**anager - Simple apt-style [yay](https://github.com/Jguer/yay) wrapper ## Description -### Why? +pkm is simple AUR helper intended to be used alongside with yay. It is not trying to be full replacement, but tries to improve and streamline installation/discovery sprocess. + +All pkm commands are simply yay commands, wrapped in apt/pamac ux, which are displayed as is except search. Search in pkm is tweaked to have minimal interface and provide better results sorting. + +![](readme/screenshot.png) ## Installation -### Source +### 1. Install [yay](https://github.com/Jguer/yay) and follow [yay first use](https://github.com/Jguer/yay#first-use) + +### 2.1 Source +Compilation of this repository requires [dlang](https://dlang.org). + +1. Clone [this repo](https://github.com/al1-ce/pkm) and build it with `dub build -b release`. +2. Copy created binary `./bin/pkm` to somewhere in your path, for example `~/.local/bin/` -### Binary +### 2.2 Binary -### AUR +1. Go to [releases](https://github.com/al1-ce/pkm/releases) and download binary. +2. Copy downloaded binary `./bin/pkm` to somewhere in your path, for example `~/.local/bin/` -## First Use + + + ## Commands -## Config +pkm commands follow pamac/apt syntax. Installing `pkm install package`, removing `pkm remove package`, etc.. + +If you want to perform any of following command only on AUR then add `--aur` or `-a` flag to your command. + +| Command | Description | yay command | +| :------ | :---------- | :---------- | +| search | Search for package. | `yay -Ss [terms...]` +| list | List installed packages. | `yay -Q` +| info | Print info about package. | `yay -Qi [packages...]` +| install | Install package. | `yay -S [packages...]` +| remove | Remove package. | `yay -R [packages...]` +| checkupdates | Checks for available updates. | `yay -Qu` +| update | Update repositories. | `yay -Sy [packages...]` +| upgrade | Upgrade installed packages. | `yay -Su [packages...]` +| clean | Clean unneeded dependencies. | `yay -Yc` +| stats | Print system statistics. | `yay -Ps` +| pkgbuild | Print PKGBUILD file | `yay -Gp [packages...]` + + + +## How to read search +All available `pkm` commands are calling `yay` with corresponding flags. This is true for search, but pkm also performs special operations to customise and improve yay's search. + +Search always follows this schema: + +``` +package-name [a] [o] [i] version/installed-version package-size/votes install-size/popularity [repo] + description +``` + +![](readme/screenshot_special.png) + +Here's small table to assist you in reading it: + +| Field | Meaning | Special notes | +| :- | :- | :- | +| package-name | Name of package. | | +| [a] | Is package orphaned. | Highlighted in red when true. "A" stands for abandoned. | +| [a] | Is package outdated. | Highlighted in red when true. | +| [a] | Is package installed. | Highlighted in green when true. | +| version | Version of package. | If installed version is different from current verison then field shows installed version hightlighed in light magenta. | +| package-size/votes | See notes. | If package from AUR: Package votes.
If package not from AUR: Package size. +| package-size/votes | See notes. | If package from AUR: Package popularity.
If package not from AUR: Installation size. +| [repo] | Repository of package. | Repository name is cropped to 3 symbols. +| description | Description. | | + +If package is from AUR then it's displaying votes/popularity instead of size and votes/popularity are highlighted in this way: -## FAQ +![](readme/votes.png) -## Images \ No newline at end of file +### Other AUR helpers/tools +- [yay](https://github.com/Jguer/yay) +- [paru](https://github.com/morganamilo/paru) +- [aurutils](https://github.com/AladW/aurutils) +- [pikaur](https://github.com/actionless/pikaur) \ No newline at end of file diff --git a/readme/printvotes.sh b/readme/printvotes.sh new file mode 100644 index 0000000..0cf35be --- /dev/null +++ b/readme/printvotes.sh @@ -0,0 +1,8 @@ +echo -e "\033[30m + \033[100m < 100 Votes \033[49m \033[100m < 1.0 Rating \033[49m + \033[101m >= 100 Votes \033[49m \033[101m >= 1.0 Rating \033[49m + \033[103m >= 250 Votes \033[49m \033[103m >= 10.0 Rating \033[49m + \033[106m >= 500 Votes \033[49m \033[106m >= 20.0 Rating \033[49m + \033[102m >= 750 Votes \033[49m \033[102m >= 30.0 Rating \033[49m + \033[104m >= 1000 Votes \033[49m \033[104m >= 40.0 Rating \033[49m +\033[39m" \ No newline at end of file diff --git a/readme/screenshot.png b/readme/screenshot.png new file mode 100644 index 0000000..1d5dafb Binary files /dev/null and b/readme/screenshot.png differ diff --git a/readme/screenshot_special.png b/readme/screenshot_special.png new file mode 100644 index 0000000..819e798 Binary files /dev/null and b/readme/screenshot_special.png differ diff --git a/readme/votes.png b/readme/votes.png new file mode 100644 index 0000000..dbd2604 Binary files /dev/null and b/readme/votes.png differ