Skip to content

Commit

Permalink
docs(contributing): remove outadated info
Browse files Browse the repository at this point in the history
  • Loading branch information
Jguer committed Jul 26, 2020
1 parent 5b7cee1 commit 2cc7268
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 15 deletions.
19 changes: 5 additions & 14 deletions CONTRIBUTING.md
Expand Up @@ -14,27 +14,15 @@ Yay depends on:
- go (make only)
- git
- base-devel
- pacman

Note: Yay also depends on a few other projects (as vendored dependencies). These
projects are stored in `vendor/`, are built into yay at build time, and do not
need to be installed separately. These files are managed as go modules and should not be modified manually.

Following are the dependencies managed as go modules:

- https://github.com/Jguer/go-alpm
- https://github.com/Morganamilo/go-srcinfo
- https://github.com/Morganamilo/go-pacmanconf
- https://github.com/mikkeloscar/aur
Note: Yay also depends on a few other projects, these are pulled as go modules.

### 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 sources its dependencies from `vendor/`. When
building manually, dependencies will instead be sourced from `GOPATH`. To
build against `vendor/` you must specify `-mod=vendor` in the build command.

#### Docker Release

`make docker-release` will build the release packages for `aarch64` and for `x86_64`.
Expand All @@ -55,6 +43,9 @@ 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.

Use [pre-commit](https://pre-commit.com/) to validate your commits against the various
linters configured for this repository.

### Testing

Run `make test` to test Yay. This command will verify that the code is
Expand Down
2 changes: 1 addition & 1 deletion README.md
Expand Up @@ -112,7 +112,7 @@ If you transition between aur helpers and did not install the devel package usin

#### I want to help out!

Check `CONTRIBUTING.md` for more information.
Check [CONTRIBUTING.md](./CONTRIBUTING.md) for more information.

## Examples of Custom Operations

Expand Down

0 comments on commit 2cc7268

Please sign in to comment.