lemonhall / covim Goto Github PK

#CoVim - Collaborative Editing for Vim One of Vim's most requested features is here!
CoVim is a Vim Plugin that adds real-time collaboration to your favorite text editor. Think Google Docs for Vim.
More info can be found on the announcement post!

##Features

• Allows multiple users to connect to the same document online
• Displays collaborators with individual cursors
• Works with your existing configuration
• Easy to set up & use

##Installation

CoVim requires a version of Vim compiled with python 2.5+. Visit the FAQ / Troubleshooting if you're having trouble starting Vim. Also note that the Twisted library can be installed via apt-get & yum as well as pip.

Install Using Pathogen:

1. pip install twisted
2. cd ~/.vim/bundle
3. git clone git://github.com/FredKSchott/CoVim.git

Install Using Vundle:

1. pip install twisted
2. Add Bundle 'FredKSchott/CoVim' to your ~/.vimrc
3. vim +BundleInstall +qall

Install Manually:

1. pip install twisted
2. Add client.vim & server.py to ~/.vim/plugin/

##Usage To start a new CoVim server: :CoVim start [port] [name] (or, from the command line: ./server.py [port])
To connect to a running server: :CoVim connect [host address / 'localhost'] [port] [name]
To disconnect: Quit Vim or :CoVim disconnect

##Links Announcement Post
FAQ / Troubleshooting