From 0413d91be3270cf2f55499cd6603baeb2c869c27 Mon Sep 17 00:00:00 2001 From: Subhaditya Nath Date: Wed, 18 Nov 2020 22:41:15 +0530 Subject: [PATCH] Update README Closes psliwka/vim-smoothie#22 --- README.md | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 28ca13d..2f66089 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -vim-smoothie: Smooth scrolling for Vim done rightšŸ„¤ +vim-smoothie: Smooth scrolling for Vim done right :cup_with_straw: =================================================== This (neo)vim plugin makes scrolling nice and _smooth_. Find yourself @@ -30,6 +30,20 @@ adjusting one or more of the following variables in your `vimrc`: supposed to bind keys you like by yourself. See `plugin/smoothie.vim` to discover available mappings. +* `g:smoothie_enabled`: Set it to `0` to disable vim-smoothie. Useful for + extremely slow connections. + +* `g:smoothie_base_speed`: Controls the speed. Set to `10` by default. To + go slower, reduce the value. To go faster, increase the value. + +* `g:smoothie_update_interval`: Time interval (in milliseconds) between + successive screen updates. Use a smaller value to get smoother + animations, or use a bigger value if you are on a slow connection. + +* `g:smoothie_break_on_reverse`: If true, then scrolling will stop + immediately when a command is given to scroll opposite to the current + direction. + Alternatives, a.k.a. why create yet another plugin -------------------------------------------------- @@ -65,7 +79,6 @@ replaces. That is, every command should still behave exactly as described in `:help scroll.txt`. There are still some deviations from the origial behavior, which hopefully will be addressed in the future: -* `^D`, `^U`, `^F`, `^B` should beep when they can't move any further. * `^F` and `^B` should respect the `window` option. * Native commands may move in a smarter way over wrapped/folded lines.