Skip to content
Snippets Groups Projects
BUILD.md 1.21 KiB
Newer Older
Junegunn Choi's avatar
Junegunn Choi committed
Building fzf
============

Build instructions
------------------

### Prerequisites

- `go` executable in $PATH

### Using Makefile

Makefile will set up and use its own `$GOPATH` under the project root.
Junegunn Choi's avatar
Junegunn Choi committed

```sh
# Build fzf binary for your platform in target
Junegunn Choi's avatar
Junegunn Choi committed
make

# Build fzf binary and copy it to bin directory
make install

# Build 32-bit and 64-bit executables and tarballs in target
Junegunn Choi's avatar
Junegunn Choi committed
make release

# Make release archives for all supported platforms in target
Junegunn Choi's avatar
Junegunn Choi committed
make release-all
Junegunn Choi's avatar
Junegunn Choi committed
```

### Using `go get`

Alternatively, you can build fzf directly with `go get` command without
Junegunn Choi's avatar
Junegunn Choi committed
manually cloning the repository.
Junegunn Choi's avatar
Junegunn Choi committed

```sh
go get -u github.com/junegunn/fzf
Junegunn Choi's avatar
Junegunn Choi committed
```

Third-party libraries used
--------------------------

- [mattn/go-runewidth](https://github.com/mattn/go-runewidth)
    - Licensed under [MIT](http://mattn.mit-license.org)
- [mattn/go-shellwords](https://github.com/mattn/go-shellwords)
    - Licensed under [MIT](http://mattn.mit-license.org)
- [mattn/go-isatty](https://github.com/mattn/go-isatty)
    - Licensed under [MIT](http://mattn.mit-license.org)
- [tcell](https://github.com/gdamore/tcell)
    - Licensed under [Apache License 2.0](https://github.com/gdamore/tcell/blob/master/LICENSE)

License
-------

[MIT](LICENSE)