mirror of
https://github.com/Jguer/yay.git
synced 2025-10-08 00:04:37 -04:00
chore(readme): update install instructions. closes #1435
This commit is contained in:
parent
c8fcdeae5b
commit
2eafbcc03e
@ -1,4 +1,22 @@
|
|||||||
## Contributing to yay
|
# Contributing to yay
|
||||||
|
|
||||||
|
## Translation
|
||||||
|
|
||||||
|
[Transifex](https://www.transifex.com/yay-1/yay/)
|
||||||
|
|
||||||
|
## Quality Assurance
|
||||||
|
|
||||||
|
```sh
|
||||||
|
pacman -S --needed git base-devel
|
||||||
|
git clone https://aur.archlinux.org/yay-git.git
|
||||||
|
cd yay-git
|
||||||
|
makepkg -si
|
||||||
|
```
|
||||||
|
|
||||||
|
Installing `yay-git` and using issues to help determine what's broken is already
|
||||||
|
a very big help.
|
||||||
|
|
||||||
|
## Development
|
||||||
|
|
||||||
Contributors are always welcome!
|
Contributors are always welcome!
|
||||||
|
|
||||||
|
60
README.md
60
README.md
@ -28,7 +28,9 @@ Yet Another Yogurt - An AUR Helper Written in Go
|
|||||||
|
|
||||||
If you are migrating from another AUR helper, you can simply install Yay with that helper.
|
If you are migrating from another AUR helper, you can simply install Yay with that helper.
|
||||||
|
|
||||||
Alternatively, the initial installation of Yay can be done by cloning the PKGBUILD and
|
### Source
|
||||||
|
|
||||||
|
The initial installation of Yay can be done by cloning the PKGBUILD and
|
||||||
building with makepkg:
|
building with makepkg:
|
||||||
|
|
||||||
Before you begin, make sure you have the `base-devel` package group installed.
|
Before you begin, make sure you have the `base-devel` package group installed.
|
||||||
@ -40,6 +42,29 @@ cd yay
|
|||||||
makepkg -si
|
makepkg -si
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### Binary
|
||||||
|
|
||||||
|
If you do not want to compile yay yourself you can use the builds generated by
|
||||||
|
GitHub Actions.
|
||||||
|
|
||||||
|
```sh
|
||||||
|
pacman -S --needed git base-devel
|
||||||
|
git clone https://aur.archlinux.org/yay-bin.git
|
||||||
|
cd yay-bin
|
||||||
|
makepkg -si
|
||||||
|
```
|
||||||
|
|
||||||
|
### Other distributions
|
||||||
|
|
||||||
|
If you're using Manjaro or [another distribution that packages `yay`](https://repology.org/project/yay/versions)
|
||||||
|
you can simply install yay using pacman (as root):
|
||||||
|
|
||||||
|
```sh
|
||||||
|
pacman -S --needed git base-devel yay
|
||||||
|
```
|
||||||
|
|
||||||
|
⚠️ distributions sometimes lag updating yay on their repositories.
|
||||||
|
|
||||||
## First Use
|
## First Use
|
||||||
|
|
||||||
#### Development packages upgrade
|
#### Development packages upgrade
|
||||||
@ -70,12 +95,12 @@ makepkg -si
|
|||||||
|
|
||||||
## Frequently Asked Questions
|
## Frequently Asked Questions
|
||||||
|
|
||||||
#### Yay does not display colored output. How do I fix it?
|
- Yay does not display colored output. How do I fix it?
|
||||||
|
|
||||||
Make sure you have the `Color` option in your `/etc/pacman.conf`
|
Make sure you have the `Color` option in your `/etc/pacman.conf`
|
||||||
(see issue [#123](https://github.com/Jguer/yay/issues/123)).
|
(see issue [#123](https://github.com/Jguer/yay/issues/123)).
|
||||||
|
|
||||||
#### Yay is not prompting to skip packages during system upgrade.
|
- Yay is not prompting to skip packages during system upgrade.
|
||||||
|
|
||||||
The default behavior was changed after
|
The default behavior was changed after
|
||||||
[v8.918](https://github.com/Jguer/yay/releases/tag/v8.918)
|
[v8.918](https://github.com/Jguer/yay/releases/tag/v8.918)
|
||||||
@ -86,43 +111,58 @@ it permanent by appending `--save`). Note: skipping packages will leave your
|
|||||||
system in a
|
system in a
|
||||||
[partially-upgraded state](https://wiki.archlinux.org/index.php/System_maintenance#Partial_upgrades_are_unsupported).
|
[partially-upgraded state](https://wiki.archlinux.org/index.php/System_maintenance#Partial_upgrades_are_unsupported).
|
||||||
|
|
||||||
#### Sometimes diffs are printed to the terminal, and other times they are paged via less. How do I fix this?
|
- Sometimes diffs are printed to the terminal, and other times they are paged via less. How do I fix this?
|
||||||
|
|
||||||
Yay uses `git diff` to display diffs, which by default tells less not to
|
Yay uses `git diff` to display diffs, which by default tells less not to
|
||||||
page if the output can fit into one terminal length. This behavior can be
|
page if the output can fit into one terminal length. This behavior can be
|
||||||
overridden by exporting your own flags (`export LESS=SRX`).
|
overridden by exporting your own flags (`export LESS=SRX`).
|
||||||
|
|
||||||
#### Yay is not asking me to edit PKGBUILDS, and I don't like the diff menu! What can I do?
|
- Yay is not asking me to edit PKGBUILDS, and I don't like the diff menu! What can I do?
|
||||||
|
|
||||||
`yay --editmenu --nodiffmenu --save`
|
`yay --editmenu --nodiffmenu --save`
|
||||||
|
|
||||||
#### How can I tell Yay to act only on AUR packages, or only on repo packages?
|
- How can I tell Yay to act only on AUR packages, or only on repo packages?
|
||||||
|
|
||||||
`yay -{OPERATION} --aur`
|
`yay -{OPERATION} --aur`
|
||||||
`yay -{OPERATION} --repo`
|
`yay -{OPERATION} --repo`
|
||||||
|
|
||||||
#### An `Out Of Date AUR Packages` message is displayed. Why doesn't Yay update them?
|
- An `Out Of Date AUR Packages` message is displayed. Why doesn't Yay update them?
|
||||||
|
|
||||||
This message does not mean that updated AUR packages are available. It means
|
This message does not mean that updated AUR packages are available. It means
|
||||||
the packages have been flagged out of date on the AUR, but
|
the packages have been flagged out of date on the AUR, but
|
||||||
their maintainers have not yet updated the `PKGBUILD`s
|
their maintainers have not yet updated the `PKGBUILD`s
|
||||||
(see [outdated AUR packages](https://wiki.archlinux.org/index.php/Arch_User_Repository#Foo_in_the_AUR_is_outdated.3B_what_should_I_do.3F)).
|
(see [outdated AUR packages](https://wiki.archlinux.org/index.php/Arch_User_Repository#Foo_in_the_AUR_is_outdated.3B_what_should_I_do.3F)).
|
||||||
|
|
||||||
#### Yay doesn't install dependencies added to a PKGBUILD during installation.
|
- Yay doesn't install dependencies added to a PKGBUILD during installation.
|
||||||
|
|
||||||
Yay resolves all dependencies ahead of time. You are free to edit the
|
Yay resolves all dependencies ahead of time. You are free to edit the
|
||||||
PKGBUILD in any way, but any problems you cause are your own and should not be
|
PKGBUILD in any way, but any problems you cause are your own and should not be
|
||||||
reported unless they can be reproduced with the original PKGBUILD.
|
reported unless they can be reproduced with the original PKGBUILD.
|
||||||
|
|
||||||
#### I know my `-git` package has updates but yay doesn't offer to update it
|
- I know my `-git` package has updates but yay doesn't offer to update it
|
||||||
|
|
||||||
Yay uses an hash cache for development packages. Normally it is updated at the end of the package install with the message `Found git repo`.
|
Yay uses an hash cache for development packages. Normally it is updated at the end of the package install with the message `Found git repo`.
|
||||||
If you transition between aur helpers and did not install the devel package using yay at some point, it is possible it never got added to the cache. `yay -Y --gendb` will fix the current version of every devel package and start checking from there.
|
If you transition between aur helpers and did not install the devel package using yay at some point, it is possible it never got added to the cache. `yay -Y --gendb` will fix the current version of every devel package and start checking from there.
|
||||||
|
|
||||||
#### I want to help out!
|
- I want to help out!
|
||||||
|
|
||||||
Check [CONTRIBUTING.md](./CONTRIBUTING.md) for more information.
|
Check [CONTRIBUTING.md](./CONTRIBUTING.md) for more information.
|
||||||
|
|
||||||
|
- What settings do you use?
|
||||||
|
|
||||||
|
```sh
|
||||||
|
yay -Y --devel --combinedupgrade --batchinstall --save
|
||||||
|
```
|
||||||
|
|
||||||
|
Pacman conf options:
|
||||||
|
|
||||||
|
```conf
|
||||||
|
UseSyslog
|
||||||
|
Color
|
||||||
|
CheckSpace
|
||||||
|
VerbosePkgLists
|
||||||
|
```
|
||||||
|
|
||||||
## Support
|
## Support
|
||||||
|
|
||||||
All support related to Yay should be requested via GitHub issues. Since Yay is not
|
All support related to Yay should be requested via GitHub issues. Since Yay is not
|
||||||
|
Loading…
x
Reference in New Issue
Block a user