summaryrefslogtreecommitdiffstats
path: root/BUILD.md
blob: 5b04f674c8b93bc8ce1ae07c256a85b43c7d48bc (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
Building fzf
============

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

### Prerequisites

- `go` executable in $PATH

### Using Makefile

Makefile will set up and use its own `$GOPATH` under the project root.

```sh
# Source files are located in src directory
cd src

# Build fzf binary for your platform in src/fzf
make

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

# Build 32-bit and 64-bit executables and tarballs
make release

# Make release archives for all supported platforms
make release-all
```

### Using `go get`

Alternatively, you can build fzf directly with `go get` command without
manually cloning the repository.

```sh
go get -u github.com/junegunn/fzf/src/fzf
```

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)