Skip to content

Commit

Permalink
Update vim help documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
kristopher-h committed Nov 4, 2017
1 parent 416a04f commit 6711146
Show file tree
Hide file tree
Showing 3 changed files with 55 additions and 10 deletions.
1 change: 0 additions & 1 deletion DEVELOPMENT.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ Todo
----

#. Clean up, refactor
#. Add documentation availible via help in vim
#. Add support for more lsp servers
#. Verify the plugin is working with vim built for python3 as well as 2
#. Add rename support
Expand Down
11 changes: 6 additions & 5 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,11 @@ Installation

The instruction below is only tested on osX and Linux.

Installation is done by downloading an extracting a release bundle, e.g. using pathogen::
Installation is done by downloading an extracting a release bundle, example::

cd ~/.vim/bundle
wget https://github.com/kristopher-h/vim-liq/releases/download/v0.1.0-beta/vim-liq.tgz
mkdir -p ~/.vim/pack/plugins/start
cd ~/.vim/pack/plugins/start
wget https://github.com/kristopher-h/vim-liq/releases/download/<version>/vim-liq.tgz
tar xzf vim-liq.tgz

.. NOTE::
Expand Down Expand Up @@ -60,10 +61,10 @@ Upgrading

To upgrade vim-liq simply remove the old vim-liq folder and redo the installation. Example::

cd ~/.vim/bundle
cd ~/.vim/pack/plugins/start
rm -r vim-liq

After that redo the installation.
After that follow the installation instruction again.

Usage
-----
Expand Down
53 changes: 49 additions & 4 deletions doc/vim-liq.txt
Original file line number Diff line number Diff line change
@@ -1,24 +1,69 @@
*vim-liq.txt* A short multi line description of your plugin
*vim-liq.txt* A language server protocol client for VIM

===============================================================================
CONTENTS *vim-liq*

1. Intro .................................................. |vim-liq-intro|
2. Requirements .................................... |vim-liq-requirements|
3. Usage .................................................. |vim-liq-usage|
3.1 Key bingings .................................... |vim-liq-keybindings|
4. Licence .............................................. |vim-liq-licence|
===============================================================================
1. Intro *vim-liq-intro*

Overview of plugin
vim-liq is a vim client for the Language Server Protocol (LSP). vim-liq stands
for something along the lines of vim- "Language IQ" or "Lingustic
Intelligence".


2. Requirements *vim-liq-requirements*

What additional programs are required to run the plugin
Vim 8, or later, with support for:

- python (2.7)
- autocommands
- quickfix
- timers
- async calls

python 2.7 or later (including python3) is needed to run the python
language server (pyls).


3. Usage *vim-liq-usage*

How to use the plugin. What functions does it give the user?
The following high level, LSP, features have support:

* Completion
* References
* Diagnostics
* Definition
* Symbols

See https://github.com/Microsoft/language-server-protocol for details on the
language server protocol features.

Diagnostics is automatically enabled and uses vim signs. When moving to a line
with a diagnostics mark the message for that line is displayed in the
command-line.

To disable the usage of signs set the following in your .vimrc::

let g:langIQ_disablesigns = 1


3.1. Key bindings *vim-liq-keybindings*

The plugin by default map the following keybindings:

CTRL-Space: completion (insert mode)
.: completion (insert mode)
LEADER-d: goto definition (normal mode)
LEADER-f: find references (normal mode)

To disbale the default key bindings set the following in your .vimrc:

let g:langIQ_disablekeymap = 1

4. Licence *vim-liq-licence*

Expand Down

0 comments on commit 6711146

Please sign in to comment.