Skip to content

Commit

Permalink
docs: Updated CONTRIBUTING.md to include build deps (#153)
Browse files Browse the repository at this point in the history
Signed-off-by: Weike Qu <[email protected]>

Issue #, if available:
- Resolves #152

*Description of changes:*
- Updated CONTRIBUTING.md with installing build dependencies.

*Testing done:*
- Ran commands locally
- Commands are used in CI E2E tests.


- [x] I've reviewed the guidance in CONTRIBUTING.md


#### License Acceptance

By submitting this pull request, I confirm that my contribution is made
under the terms of the Apache 2.0 license.

Signed-off-by: Weike Qu <[email protected]>
  • Loading branch information
weikequ authored Jan 12, 2023
1 parent 603419a commit bfdaf56
Showing 1 changed file with 15 additions and 1 deletion.
16 changes: 15 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ This is needed because we use `Loose` instead of `Strict` regarding [branch prot

## Development Environment Setup

This section describes how one can develop Finch CLI locally on macOS, build it, and then run it to test out the changes. The design ensures that the local development environment is isolated from the installation (i.e., we should not need to run `make install` to do local development).
This section describes how one can develop Finch CLI locally on macOS, build it, and then run it to test out the changes. The design ensures that the local development environment is isolated from the installation (i.e., we should not need to run `make install` to do local development). Please note that this section uses [Homebrew](https://brew.sh/) to install dependencies.

### Linter

Expand All @@ -111,6 +111,20 @@ To integrate it into your IDE, please check out the [official documentation](htt

For more details, see [`.golangci.yaml`](./.golangci.yaml) and the `lint` target in [`Makefile`](./Makefile).

### Install dependencies

Before building, install dependencies required to build the project binaries.

```sh
brew install go lz4 automake autoconf libtool
```

Note that you may need to add the following to the `.profile` file of your shell if `which libtool` does not return the one installed by Homebrew. The one that comes with macOS is too old for our use.

```sh
export PATH="/opt/homebrew/opt/libtool/libexec/gnubin:$PATH"
```

### Build

After cloning the repo, run `make` to build the binary.
Expand Down

0 comments on commit bfdaf56

Please sign in to comment.