Skip to content
This repository has been archived by the owner on Apr 13, 2024. It is now read-only.

Commit

Permalink
Updated readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
lyuts committed Jul 19, 2014
1 parent 748a2e4 commit 9c2138b
Showing 1 changed file with 46 additions and 1 deletion.
47 changes: 46 additions & 1 deletion README.md
Expand Up @@ -5,7 +5,52 @@ Vim bindings for rtags.
https://github.com/Andersbakken/rtags

# Requirements
1. Vim built with +python.
1. Vim built with ```+python```.

# Installation
## Vundle
Add the following line to ```.vimrc```

Plugin 'lyuts/vim-rtags'

then while in vim run:

:source %
:PluginInstall

## NeoBundle
Add the following line to ```.vimrc```

NeoBundle 'lyuts/vim-rtags'

then while in vim run:

:source %
:NeoBundleInstall

## Pathogen
$ cd ~/.vim/bundle
$ git clone https://github.com/lyuts/vim-rtags

# Configuration
This plugin interacts with RTags by invoking ```rc``` commands and interpreting
their results. You can override the path to ```rc``` binary by setting
```g:rcCmd``` variable. By default, it is set to ```rc```, expecting it to be
found in the $PATH.

Out of box this plugin provides mappings. In order to use custom mappings the
default mappings can be disabled:

let g:rtagsUseDefaultMappings = 0

# Usage

# Notes
1. This plugin is wip.
1. Code completion with rtags is not done yet.

# Development
Unit tests for some plugin functions can be found in ```tests``` directory.
To run tests, execute:

$ vim tests/test_rtags.vim +UnitTest

0 comments on commit 9c2138b

Please sign in to comment.