mirror of
https://github.com/Jguer/yay
synced 2024-10-31 04:12:51 +00:00
README grammar, spelling, rewording, organizing (#661)
* README grammar, spelling, rewording, organizing - Add "Objectives" section to group objectives. - Transform Objective/Feature section bullets into action phrases. - Fix yay/yaourt/etc capitalization. Italicize and follow ArchWiki style. - Clearly identify the two Install section options with similar wording. - Reorganize and reword Contributing section. - Fix wording in last Code Style section sentence. - Fix misc FAQ wording. - Use same style for all FAQ issue links. - Change link in "skipping packages" FAQ item to ArchWiki partial upgrade. - Fix FAQ aur-only/repo-only cmd example line-spacing. - Remove yay -Pu example since it is a deprecated (and wrapped) option. * Fixup remove trailing newline in README file * Add warning about editing files in vendor/ * Fixup revert italicized project/program names * Change obj to Yaourt-style interactive srch/inst * Change obj to Minimal dependencies * Remove the limit-to-pacman deps feature * Revert init-install sentence, but add "alternatively" * Add provide-handling bullet to features * Revert aur/repo-only FAQ item to one line * Format cmd line examples similar to man page format * Revert interface-for-pacman objective * Mention dep instead of just saying don't touch * Merge gopath into the build stage Setting the gopath is more of a note than a step. It is not required and I would expect most people can simply ignore it. * Reword dependencies section. The contributing section should be information and say what dependencies are needed. There's no need to tell the user how to install them, they can figure that out themselves. Also mention git as a dependency. * Tweak headings and drop numbers Similar to the last commit. The headings should be informative "Code Style", not commanding "Check code". * yay -> Yay Be more consistent when writing Yay as a name. * Use ### instead of #### in Contributing These are real subheadings, #### looks too small. * Add support section
This commit is contained in:
digimokan
Anna
parent
5e23a2fc6b
commit
0a120132ec
1 changed files with 103 additions and 67 deletions
170
README.md
170
README.md
|
|
@ -1,45 +1,59 @@
|
||||||
# yay
|
# Yay
|
||||||
|
|
||||||
Yet another Yogurt - An AUR Helper written in Go
|
Yet Another Yogurt - An AUR Helper Written in Go
|
||||||
|
|
||||||
#### Packages
|
#### Packages
|
||||||
|
|
||||||
[](https://aur.archlinux.org/packages/yay/) [](https://aur.archlinux.org/packages/yay-bin/) [](https://aur.archlinux.org/packages/yay-git/) [](https://github.com/Jguer/yay/blob/master/LICENSE)
|
[](https://aur.archlinux.org/packages/yay/) [](https://aur.archlinux.org/packages/yay-bin/) [](https://aur.archlinux.org/packages/yay-git/) [](https://github.com/Jguer/yay/blob/master/LICENSE)
|
||||||
|
|
||||||
|
## Objectives
|
||||||
|
|
||||||
There's a point in everyone's life when you feel the need to write an AUR helper because there are only about 20 of them.
|
There's a point in everyone's life when you feel the need to write an AUR helper because there are only about 20 of them.
|
||||||
So say hi to 20+1.
|
So say hi to 20+1.
|
||||||
|
|
||||||
Yay was created with a few objectives in mind and based on the design of [yaourt](https://github.com/archlinuxfr/yaourt), [apacman](https://github.com/oshazard/apacman) and [pacaur](https://github.com/rmarquis/pacaur):
|
Yay is based on the design of [yaourt](https://github.com/archlinuxfr/yaourt), [apacman](https://github.com/oshazard/apacman) and [pacaur](https://github.com/rmarquis/pacaur). It is developed with these objectives in mind:
|
||||||
|
|
||||||
* Have almost no dependencies
|
|
||||||
* Provide an interface for pacman
|
* Provide an interface for pacman
|
||||||
* Have yaourt-like search
|
* Yaourt-style interactive search/install
|
||||||
|
* Minimal dependencies
|
||||||
* Minimize user input
|
* Minimize user input
|
||||||
* Know when git packages are due for an upgrade
|
* Know when git packages are due for upgrades
|
||||||
|
|
||||||
## Features
|
## Features
|
||||||
|
|
||||||
* AUR Tab completion
|
* Perform advanced dependency solving
|
||||||
* Download PKGBUILD from ABS or AUR
|
* Download PKGBUILDs from ABS or AUR
|
||||||
* Ask all questions first and then start building
|
* Tab-complete the AUR
|
||||||
* Search narrowing (`yay linux header` will first search linux and then narrow on header)
|
* Query user up-front for all input (prior to starting builds)
|
||||||
* No sourcing of PKGBUILD is done
|
* Narrow search terms (`yay linux header` will first search `linux` and then narrow on `header`)
|
||||||
* The binary has no dependencies that pacman doesn't already have
|
* Find matching package providers during search and allow selection
|
||||||
* Advanced dependency solving
|
|
||||||
* Remove make dependencies at the end of the build process
|
* Remove make dependencies at the end of the build process
|
||||||
|
* Run without sourcing PKGBUILD
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
If you are migrating from another AUR helper you can simply install Yay from
|
If you are migrating from another AUR helper, you can simply install Yay with that helper.
|
||||||
the AUR like any other package.
|
|
||||||
|
|
||||||
The initial installation of Yay can be done by cloning the PKGBUILD and
|
Alternatively, the initial installation of Yay can be done by cloning the PKGBUILD and
|
||||||
building with makepkg.
|
building with makepkg:
|
||||||
```sh
|
```sh
|
||||||
git clone https://aur.archlinux.org/yay.git
|
git clone https://aur.archlinux.org/yay.git
|
||||||
cd yay
|
cd yay
|
||||||
makepkg -si
|
makepkg -si
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Support
|
||||||
|
|
||||||
|
All support related to Yay should be requested via GitHub issues. Since Yay is not
|
||||||
|
officially supported by Arch Linux, support should not be sought out on the
|
||||||
|
forums, AUR comments or other official channels.
|
||||||
|
|
||||||
|
A broken AUR package should be reported as a comment on the package's AUR page.
|
||||||
|
A package may only be considered broken if it fails to build with makepkg.
|
||||||
|
Reports should be made using makepkg and include the full output as well as any
|
||||||
|
other relevant information. Never make reports using Yay or any other external
|
||||||
|
tools.
|
||||||
|
|
||||||
## Contributing
|
## Contributing
|
||||||
|
|
||||||
Contributors are always welcome!
|
Contributors are always welcome!
|
||||||
|
|
@ -49,83 +63,105 @@ on, we suggest opening an issue detailing your ideas first.
|
||||||
|
|
||||||
Otherwise send us a pull request and we will be happy to review it.
|
Otherwise send us a pull request and we will be happy to review it.
|
||||||
|
|
||||||
### Code Style
|
### Dependencies
|
||||||
|
|
||||||
All code should be formatted through `go fmt`. This tool will automatically
|
Yay depends on:
|
||||||
format code for you. Although it is recommended you write code in this style
|
|
||||||
and just use this tool to catch mistakes.
|
|
||||||
|
|
||||||
### Building
|
* go (make only)
|
||||||
|
* git
|
||||||
|
* base-devel
|
||||||
|
|
||||||
Yay is easy to build with its only build dependency being `go` and the
|
Note: Yay also depends on a few other projects (as vendored dependencies). These
|
||||||
assumption of `base-devel` being installed.
|
projects are stored in `vendor/`, are built into yay at build time, and do not
|
||||||
|
need to be installed separately. These files are managed by
|
||||||
|
[dep](https://github.com/golang/dep) and should not be modified manually.
|
||||||
|
|
||||||
Run `make` to build Yay. This will generate a binary called `yay` in the same
|
Following are the dependencies managed under dep:
|
||||||
directory as the Makefile.
|
|
||||||
|
|
||||||
Run `make test` to test Yay. This will check the code is formatted correctly,
|
|
||||||
run the code through `go vet` and run unit tests.
|
|
||||||
|
|
||||||
Yay's Makefile automatically sets the `GOPATH` to `$PWD/.go`. This makes it easy to
|
|
||||||
build using the dependencies in `vendor/`. Running manual go commands such as
|
|
||||||
`go build` will require that you to either set the `GOPATH` manually or `go get`
|
|
||||||
The dependencies into your own `GOPATH`.
|
|
||||||
|
|
||||||
### Vendored Dependencies
|
|
||||||
|
|
||||||
Yay depends on a couple of other projects. These are stored in `vendor/` and
|
|
||||||
are built into Yay at build time. They do not need to be installed separately.
|
|
||||||
|
|
||||||
Currently yay Depends on:
|
|
||||||
|
|
||||||
* https://github.com/Jguer/go-alpm
|
* https://github.com/Jguer/go-alpm
|
||||||
* https://github.com/Morganamilo/go-srcinfo
|
* https://github.com/Morganamilo/go-srcinfo
|
||||||
* https://github.com/mikkeloscar/aur
|
* https://github.com/mikkeloscar/aur
|
||||||
|
|
||||||
|
### Building
|
||||||
|
|
||||||
|
Run `make` to build Yay. This command will generate a binary called `yay` in
|
||||||
|
the same directory as the Makefile.
|
||||||
|
|
||||||
|
Note: Yay's Makefile automatically sets the `GOPATH` to `$PWD/.go`. This path will
|
||||||
|
ensure dependencies in `vendor/` are built. Running manual go commands such as
|
||||||
|
`go build` will require that you either set the `GOPATH` manually or `go get`
|
||||||
|
the vendored dependencies into your own `GOPATH`.
|
||||||
|
|
||||||
|
### Code Style
|
||||||
|
|
||||||
|
All code should be formatted through `go fmt`. This tool will automatically
|
||||||
|
format code for you. We recommend, however, that you write code in the proper
|
||||||
|
style and use `go fmt` only to catch mistakes.
|
||||||
|
|
||||||
|
### Testing
|
||||||
|
|
||||||
|
Run `make test` to test Yay. This command will verify that the code is
|
||||||
|
formatted correctly, run the code through `go vet`, and run unit tests.
|
||||||
|
|
||||||
## 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` [#123](https://github.com/Jguer/yay/issues/123)
|
Make sure you have the `Color` option in your `/etc/pacman.conf`
|
||||||
|
(see issue [#123](https://github.com/Jguer/yay/issues/123)).
|
||||||
|
|
||||||
#### Yay is not prompting to skip packages during sysupgrade (issue [#554](https://github.com/Jguer/yay/issues/554))
|
#### Yay is not prompting to skip packages during system upgrade.
|
||||||
The default behavior was changed after [v8.918](https://github.com/Jguer/yay/releases/tag/v8.918)
|
The default behavior was changed after
|
||||||
(see: [3bdb534](https://github.com/Jguer/yay/commit/3bdb5343218d99d40f8a449b887348611f6bdbfc)).
|
[v8.918](https://github.com/Jguer/yay/releases/tag/v8.918)
|
||||||
To restore such behavior use `--combinedupgrade`. This can also be
|
(see [3bdb534](https://github.com/Jguer/yay/commit/3bdb5343218d99d40f8a449b887348611f6bdbfc)
|
||||||
permanently enabled by appending `--save`.
|
and issue [#554](https://github.com/Jguer/yay/issues/554)).
|
||||||
Note: this causes [native pacman](https://wiki.archlinux.org/index.php/AUR_helpers) to become partial.
|
To restore the package-skip behavior use `--combinedupgrade` (make
|
||||||
|
it permanent by appending `--save`). Note: skipping packages will leave your
|
||||||
|
system in a
|
||||||
|
[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, by default git tells less to not page
|
Yay uses `git diff` to display diffs, which by default tells less not to
|
||||||
if the output can fit one terminal length. This can be overridden by
|
page if the output can fit into one terminal length. This behavior can be
|
||||||
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 diff menu! What 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`
|
||||||
|
|
||||||
#### Only act 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`
|
||||||
|
|
||||||
#### `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 means the package has been flagged out of date on the AUR, but its
|
This message does not mean that updated AUR packages are available. It means
|
||||||
maintainer has not yet updated the `PKGBUILD`.
|
means the packages have been flagged out of date on the AUR, but
|
||||||
|
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)).
|
||||||
|
|
||||||
#### Yay doesn't install dependencies added to 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.
|
||||||
|
|
||||||
## Examples of Custom Operations
|
## Examples of Custom Operations
|
||||||
|
|
||||||
* `yay <Search Term>` presents package selection menu
|
`yay <Search Term>`
|
||||||
* `yay -Ps` prints system statistics
|
Present package-installation selection menu.
|
||||||
* `yay -Pu` prints update list
|
|
||||||
* `yay -Yc` cleans unneeded dependencies
|
`yay -Ps`
|
||||||
* `yay -G` downloads PKGBUILD from ABS or AUR
|
Print system statistics.
|
||||||
* `yay -Y --gendb` generates development package DB used for devel updates.
|
|
||||||
* `yay -Syu --devel --timeupdate` Normal update but also check for development
|
`yay -Yc`
|
||||||
package updates and uses PKGBUILD modification time and not version to
|
Clean unneeded dependencies.
|
||||||
determine update
|
|
||||||
|
`yay -G <AUR Package>`
|
||||||
|
Download PKGBUILD from ABS or AUR.
|
||||||
|
|
||||||
|
`yay -Y --gendb`
|
||||||
|
Generate development package database used for devel update.
|
||||||
|
|
||||||
|
`yay -Syu --devel --timeupdate`
|
||||||
|
Perform system upgrade, but also check for development package updates and use
|
||||||
|
PKGBUILD modification time (not version number) to determine update.
|
||||||
|
|
||||||
## Images
|
## Images
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue