summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJunegunn Choi <junegunn.c@gmail.com>2017-01-31 21:43:41 +0900
committerJunegunn Choi <junegunn.c@gmail.com>2017-01-31 21:43:41 +0900
commit5b749e2d5c469f85ec7f77923829b5981c2a4ca6 (patch)
tree4383d95447e3c8233a9a547f5281733addda2ea7
parentd85a69a7092ac88bf0609643d9a2ad77d4d69ca9 (diff)
Update documentation
-rw-r--r--BUILD.md56
-rw-r--r--README.md37
2 files changed, 15 insertions, 78 deletions
diff --git a/BUILD.md b/BUILD.md
index ca97e09c..5b04f674 100644
--- a/BUILD.md
+++ b/BUILD.md
@@ -25,65 +25,22 @@ make install
# Build 32-bit and 64-bit executables and tarballs
make release
-# Build executables and tarballs for Linux using Docker
-make linux
+# Make release archives for all supported platforms
+make release-all
```
### Using `go get`
Alternatively, you can build fzf directly with `go get` command without
-cloning the repository.
+manually cloning the repository.
```sh
go get -u github.com/junegunn/fzf/src/fzf
```
-Build options
--------------
-
-### With ncurses 6
-
-The official binaries of fzf are built with ncurses 5 because it's widely
-supported by different platforms. However ncurses 5 is old and has a number of
-limitations.
-
-1. Does not support more than 256 color pairs (See [357][357])
-2. Does not support italics
-3. Does not support 24-bit color
-
-[357]: https://github.com/junegunn/fzf/issues/357
-
-But you can manually build fzf with ncurses 6 to overcome some of these
-limitations. ncurses 6 supports up to 32767 color pairs (1), and supports
-italics (2). To build fzf with ncurses 6, you have to install it first. On
-macOS, you can use Homebrew to install it.
-
-```sh
-brew install homebrew/dupes/ncurses
-LDFLAGS="-L/usr/local/opt/ncurses/lib" make install
-```
-
-### With tcell
-
-[tcell][tcell] is a portable alternative to ncurses and we currently use it to
-build Windows binaries. tcell has many benefits but most importantly, it
-supports 24-bit colors. To build fzf with tcell:
-
-```sh
-TAGS=tcell make install
-```
-
-However, note that tcell has its own issues.
-
-- Poor rendering performance compared to ncurses
-- Does not support bracketed-paste mode
-- Does not support italics unlike ncurses 6
-- Some wide characters are not correctly displayed
-
Third-party libraries used
--------------------------
-- [ncurses][ncurses]
- [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)
@@ -97,10 +54,3 @@ License
-------
[MIT](LICENSE)
-
-[install]: https://github.com/junegunn/fzf#installation
-[go]: https://golang.org/
-[gil]: http://en.wikipedia.org/wiki/Global_Interpreter_Lock
-[ncurses]: https://www.gnu.org/software/ncurses/
-[req]: http://golang.org/doc/install
-[tcell]: https://github.com/gdamore/tcell
diff --git a/README.md b/README.md
index de69d012..303ca4cd 100644
--- a/README.md
+++ b/README.md
@@ -72,16 +72,6 @@ But it's recommended that you use a plugin manager like
Plug 'junegunn/fzf', { 'dir': '~/.fzf', 'do': './install --all' }
```
-### Upgrading fzf
-
-fzf is being actively developed and you might want to upgrade it once in a
-while. Please follow the instruction below depending on the installation
-method used.
-
-- git: `cd ~/.fzf && git pull && ./install`
-- brew: `brew update; brew reinstall fzf`
-- vim-plug: `:PlugUpdate fzf`
-
### Windows
Pre-built binaries for Windows can be downloaded [here][bin]. However, other
@@ -91,6 +81,17 @@ flawlessly.
[wsl]: https://blogs.msdn.microsoft.com/wsl/
+Upgrading fzf
+-------------
+
+fzf is being actively developed and you might want to upgrade it once in a
+while. Please follow the instruction below depending on the installation
+method used.
+
+- git: `cd ~/.fzf && git pull && ./install`
+- brew: `brew update; brew reinstall fzf`
+- vim-plug: `:PlugUpdate fzf`
+
Building fzf
------------
@@ -357,7 +358,7 @@ If you have set up fzf for Vim, `:FZF` command will be added.
" With options
:FZF --no-sort --reverse --inline-info /tmp
-" Bang version starts in fullscreen instead of using tmux pane or Neovim split
+" Bang version starts fzf in fullscreen mode
:FZF!
```
@@ -408,20 +409,6 @@ command! -bang MyStuff
Tips
----
-#### Rendering issues
-
-If you have any rendering issues, check the following:
-
-1. Make sure `$TERM` is correctly set. fzf will use 256-color only if it
- contains `256` (e.g. `xterm-256color`)
-2. If you're on screen or tmux, `$TERM` should be either `screen` or
- `screen-256color`
-3. Some terminal emulators (e.g. mintty) have problem displaying default
- background color and make some text unable to read. In that case, try
- `--black` option. And if it solves your problem, I recommend including it
- in `FZF_DEFAULT_OPTS` for further convenience.
-4. If you still have problem, try `--no-256` option or even `--no-color`.
-
#### Respecting `.gitignore`, `.hgignore`, and `svn:ignore`
[ag](https://github.com/ggreer/the_silver_searcher) or