Skip to content

Commit 3ed83e9

Browse files
committed
Added completion to README
1 parent e9a2c38 commit 3ed83e9

1 file changed

Lines changed: 39 additions & 24 deletions

File tree

README.md

Lines changed: 39 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -11,46 +11,50 @@
1111
**Yup** helps you install packages with ease on Arch Linux
1212

1313
## Features
14+
1415
- Searching with `yup [search-terms]` returns most accurate results
15-
![](assets/scr1.png?raw=true)
16+
![](assets/scr1.png?raw=true)
1617

17-
- Uses *ncurses* to display search results. This allows for mouse interaction in the terminal and easier navigation.
18-
[![asciicast](https://asciinema.org/a/VGzR3JYAjGqT91SfiKjBUfFkh.svg)](https://asciinema.org/a/VGzR3JYAjGqT91SfiKjBUfFkh)
18+
- Uses _ncurses_ to display search results. This allows for mouse interaction in the terminal and easier navigation.
19+
[![asciicast](https://asciinema.org/a/VGzR3JYAjGqT91SfiKjBUfFkh.svg)](https://asciinema.org/a/VGzR3JYAjGqT91SfiKjBUfFkh)
1920

2021
- Don't want to use ncurses? Use `yup -n` to use non-ncurses mode
2122

2223
- Want to search the AUR exclusively? Use `yup -a`
2324

24-
- Like *yay*, type `yup` to run a system upgrade.
25+
- Like _yay_, type `yup` to run a system upgrade.
2526

2627
- An easy to use config file located at `~/.config/yup/config.json` in JSON format.
27-
2828

29-
- Want to see which packages are cluttering up your system? Run `yup -Qos` to get a list ordered package size.
29+
* Want to see which packages are cluttering up your system? Run `yup -Qos` to get a list ordered package size.
30+
3031
## Configuration
32+
3133
- Config file found at `~/.config/yup/config.json`.
3234
- The config file has the following options:
33-
```
34-
{
35-
SortMode: "closest"|"none", # changes how results are sorted (more to come)
36-
Ncurses: bool, # Whether to default to ncurses or not (override by -n)
37-
Update: bool, # Whether to update the pacman repos before every sync command
38-
PrintPkg: bool, # Whether to print the PKGBUILD before install (for AUR)
39-
AskPkg: bool, # Whether to ask to edit PKGBUILD before install (only if PrintPkg is true)
40-
AskRedo: bool, # Whether to ask if you want to reselect packages before install
41-
SilentUpdate: bool, # Whether you want to be asked to edit PKGBUILD during system update (overrides PrintPkg)
42-
PacmanLimit: int, # The number of packages parsed from pacman to be sorted and searched
43-
AurLimit: int, # The number of packages parsed from the AUR to be sorted and searched
44-
VimKeybindings: bool, # Enabling Vim keybindings (j and k keys to go up and down)
45-
}
46-
```
35+
```
36+
{
37+
)
38+
)
39+
d
40+
)
41+
)
42+
l
43+
)
44+
d
45+
d
46+
)
47+
}
48+
```
49+
4750
## Usage
51+
4852
```
4953
yup Updates AUR and pacman packages (Like -Syu)
5054
yup <package(s)> Searches for that packages and provides an install dialogue
5155
Operations:
52-
yup {-h --help}
53-
yup {-V --version}
56+
yup {-h --help}
57+
yup {-V --version}
5458
yup {-D --database} <options> <package(s)>
5559
yup {-F --files} <options> <package(s)>
5660
yup {-Q --query} <options> <package(s)>
@@ -68,11 +72,12 @@ Custom operations:
6872
```
6973

7074
## Differences between yay or trizen
75+
7176
- Yup gives you the **most accurate results** first. As seen in the example above, yup sorts the results to bring the most accurate to the start.
7277

7378
- `Yupfiles` are small files that allow you to batch install packages with a single command. [Here's an example Yupfile](test.Yupfile)
7479

75-
- Yup uses *ncurses*. This allows users to both scroll while not displacing the bottom bar and easily navigate to certain results using more natural forms of user input.
80+
- Yup uses _ncurses_. This allows users to both scroll while not displacing the bottom bar and easily navigate to certain results using more natural forms of user input.
7681

7782
- Yup has an easy config file seperate to that of pacman's. This allows it to be more customisable from the get go.
7883

@@ -84,26 +89,36 @@ Custom operations:
8489

8590
- After selecting packages to install, you can revise your decision if you made a mistake.
8691

87-
- Yup will *soon* allow you to disable any of the dialogue during install using the config menu.
92+
- Yup will _soon_ allow you to disable any of the dialogue during install using the config menu.
8893

8994
## Installing
95+
9096
### From the AUR
97+
9198
1. `git clone https://aur.archlinux.org/yup.git`
9299
2. `cd yup`
93100
3. `makepkg -si`
94101

95102
### From the AUR (binary)
103+
96104
1. `git clone https://aur.archlinux.org/yup-bin.git`
97105
2. `cd yup-bin`
98106
3. `makepkg -si`
99107

100108
### From source
109+
101110
Make sure you have `go>=1.12`, `ncurses` and `make`.
111+
102112
1. Clone the repo
103113
2. Run `make`
104114
3. Install with `make install`
105115

116+
### Completions not working on zsh
117+
118+
- You'll need to add `compaudit && compinit` to the bottom of your .zshrc
119+
106120
## Credits
121+
107122
Copyright 2019 Eric Moynihan
108123

109124
Inspired by [Jguer](https://github.com/Jguer)'s [yay](https://github.com/Jguer/yay)

0 commit comments

Comments
 (0)