Tweak readme, add install and contrib sections

This commit is contained in:
morganamilo 2018-05-11 03:59:41 +01:00
parent a634c2d167
commit 4c2986a036
No known key found for this signature in database
GPG key ID: 6FE9E7996B0B082E

View file

@ -8,7 +8,7 @@ Yet another Yogurt - An AUR Helper written in Go
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) and [apacman](https://github.com/oshazard/apacman): 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):
* Have almost no dependencies. * Have almost no dependencies.
* Provide an interface for pacman. * Provide an interface for pacman.
@ -24,15 +24,73 @@ Yay was created with a few objectives in mind and based on the design of [yaourt
* Search narrowing (`yay linux header` will first search linux and then narrow on header) * Search narrowing (`yay linux header` will first search linux and then narrow on header)
* No sourcing of PKGBUILD is done * No sourcing of PKGBUILD is done
* The binary has no dependencies that pacman doesn't already have. * The binary has no dependencies that pacman doesn't already have.
* Sources build dependencies * Advanced dependency solving
* Removes make dependencies at the end of build process * Remove make dependencies at the end of the build process
#### Frequently Asked Questions ## Installation
If you are migrating from another AUR helper you can simply install Yay from
the AUR like any other package.
The initial installation of Yay can be done by cloning the PKGBUILD and
building with makepkg.
```sh
git clone https://aur.archlinux.org/yay.git
cd yay
makepkg -si
```
## Contributing
Contributors are always welcome!
If you plan to make any large changes or changes that may not be 100% agreed
on, we suggest opening an issue detailing your ideas first.
Otherwise send us a pull request and we will be happy to review it.
### Code Style
All code should be formated through `go fmt`. This tool will automatically
format code for you. Although it is recommended you write code in this style
and just use this tool to catch mistakes.
### Building
Yay is easy to build with its only build dependency being `go` and the
assumption of `base-devel` being installed.
Run `make` to build Yay. This will generate a binary called `yay` in the same
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 automaticly 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 seperatly.
Currently yay Depends on:
* https://github.com/Jguer/go-alpm
* https://github.com/mikkeloscar/gopkgbuild
* https://github.com/mikkeloscar/aur
## 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` [#123](https://github.com/Jguer/yay/issues/123)
#### Example of Custom Operations ## Examples of Custom Operations
* `yay <Search Term>` presents package selection menu * `yay <Search Term>` presents package selection menu
* `yay -Ps` prints system statistics * `yay -Ps` prints system statistics
@ -44,6 +102,8 @@ Yay was created with a few objectives in mind and based on the design of [yaourt
package updates and uses PKGBUILD modification time and not version to package updates and uses PKGBUILD modification time and not version to
determine update determine update
## Images
<img src="https://cdn.rawgit.com/Jguer/jguer.github.io/5412b8d6/yay/yay-ps.png" width="450"> <img src="https://cdn.rawgit.com/Jguer/jguer.github.io/5412b8d6/yay/yay-ps.png" width="450">
<img src="https://cdn.rawgit.com/Jguer/jguer.github.io/5412b8d6/yay/yayupgrade.png" width="450"> <img src="https://cdn.rawgit.com/Jguer/jguer.github.io/5412b8d6/yay/yayupgrade.png" width="450">
<img src="https://cdn.rawgit.com/Jguer/jguer.github.io/5412b8d6/yay/yaysearch.png" width="450"> <img src="https://cdn.rawgit.com/Jguer/jguer.github.io/5412b8d6/yay/yaysearch.png" width="450">