From 894a350ad2583256e8825a8e47a82346d6f2985a Mon Sep 17 00:00:00 2001 From: baabelfish Date: Tue, 29 Mar 2016 11:03:35 +0300 Subject: [PATCH] Added caveats --- README.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index df4bdde..824ab20 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ Nim support for vim and advanced support for neovim. Still in heavy development. ## Features - Asynchronous -- Syntax highlighting +- Up to date syntax highlighting - Normal vim highlight - More intelligent highlight with nimsuggest (**experimental**) - Semantic highlighting for specified nim symbol kinds (**experimental**) @@ -33,6 +33,8 @@ Nim support for vim and advanced support for neovim. Still in heavy development. ## Installation +This plugin doesn't work if [zah's nim plugin](https://github.com/zah/nim.vim) is installed. + ### Dependencies - Linux (OS X and Windows untested at the moment) - [Nim](http://nim-lang.org/) (0.13.0) @@ -42,6 +44,7 @@ Nim support for vim and advanced support for neovim. Still in heavy development. - Optional: [vim-operator-user](https://github.com/kana/vim-operator-user) for defining routine text object - Optional: [unite-outline](https://github.com/h1mesuke/unite-outline) for jumping to symbols inside module +- Optional: [YouCompleteMe](https://github.com/Valloric/YouCompleteMe) for jumping to symbols inside module ### Configuration @@ -76,6 +79,12 @@ git clone https://github.com/baabelfish/nvim-nim ~/.vim/bundle/nvim-nim #### Symbol usage listing ![Usages](https://raw.githubusercontent.com/baabelfish/nvim-nim/master/misc/screenshots/usages.png) +## Caveats (Will be fixed asap) +- No support for main/project file yet +- Launching new nimsuggest for every completion +- Using stdio to communicate with nimsuggest +- Docstring is still missing +- Completion is a bit wonky with plain vim. Works well with [YouCompleteMe](https://github.com/Valloric/YouCompleteMe) ## Planned features