From cec76e3fbebbd977c75cd87e77407f27860bad07 Mon Sep 17 00:00:00 2001 From: Nicolai Skogheim Date: Sun, 1 Feb 2015 22:16:50 +0100 Subject: [PATCH 1/6] Changes Bundle to Plugin in Vundle instructions For reference: https://github.com/gmarik/Vundle.vim/pull/403 --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 9428096..46aaa65 100644 --- a/README.md +++ b/README.md @@ -31,8 +31,8 @@ Also note that the Twisted & Argparse libraries can also be installed via apt-ge ####Install With [Vundle](https://github.com/gmarik/vundle): 1. `pip install twisted argparse` -2. Add `Bundle 'FredKSchott/CoVim'` to your `~/.vimrc` -3. `vim +BundleInstall +qall` +2. Add `Plugin 'FredKSchott/CoVim'` to your `~/.vimrc` +3. `vim +PluginInstall +qall` ####Install Manually: From 4f802ac6cb3d543ea6faa4c15017ca3f1a198c45 Mon Sep 17 00:00:00 2001 From: "Fred K. Schott" Date: Fri, 8 Jan 2016 11:29:03 -0800 Subject: [PATCH 2/6] Fix broken README icon --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 46aaa65..b5f4ddf 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ - CoVim + CoVim ========================== Collaborative Editing for Vim (One of Vim's [most requested features](http://www.vim.org/sponsor/vote_results.php)) is finally here! Think Google Docs for Vim. From 181ed37d6c2778f26d29775009d1e657c6c701a9 Mon Sep 17 00:00:00 2001 From: "Fred K. Schott" Date: Fri, 8 Jan 2016 11:30:49 -0800 Subject: [PATCH 3/6] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index b5f4ddf..caf36eb 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ - CoVim + CoVim ========================== Collaborative Editing for Vim (One of Vim's [most requested features](http://www.vim.org/sponsor/vote_results.php)) is finally here! Think Google Docs for Vim. From b08f6b94076d18f8b2bc5a70c2ff1c6d0d6aa036 Mon Sep 17 00:00:00 2001 From: Alexei Date: Wed, 28 Dec 2016 23:46:36 +0100 Subject: [PATCH 4/6] Add service_identity dependency Without service_identity installed, we get this warning: UserWarning: You do not have a working installation of the service_identity module: 'No module named service_identity'. Please install it from and make sure all of its dependencies are satisfied. Without the service_identity module and a recent enough pyOpenSSL to support it, Twisted can perform only rudimentary TLS client hostname verification. Many valid certificate/hostname mappings may be rejected. --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index caf36eb..fb461c6 100644 --- a/README.md +++ b/README.md @@ -24,19 +24,19 @@ Also note that the Twisted & Argparse libraries can also be installed via apt-ge ####Install With [Pathogen](https://github.com/tpope/vim-pathogen): -1. `pip install twisted argparse` +1. `pip install twisted argparse service_identity` 2. `cd ~/.vim/bundle` 3. `git clone git://github.com/FredKSchott/CoVim.git` ####Install With [Vundle](https://github.com/gmarik/vundle): -1. `pip install twisted argparse` +1. `pip install twisted argparse service_identity` 2. Add `Plugin 'FredKSchott/CoVim'` to your `~/.vimrc` 3. `vim +PluginInstall +qall` ####Install Manually: -1. `pip install twisted argparse` +1. `pip install twisted argparse service_identity` 2. Add `CoVimClient.vim` & `CoVimServer.py` to `~/.vim/plugin/` > If Vim is having trouble finding modules (twisted, argparse, etc) do the following: From 369215c7bbd6eb45ec4d8115097512583d6df5ee Mon Sep 17 00:00:00 2001 From: Lars Volker Date: Thu, 2 Feb 2017 02:07:08 +0100 Subject: [PATCH 5/6] Update "More!" link in README.md Fixed broken link --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index fb461c6..de1fafc 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ __Follow [@FredKSchott](http://www.twitter.com/fredkschott) for development news - Displays collaborators with uniquely colored cursors - Works with your existing configuration - Easy to set up & use -- And [More!](http://www.fredkschott.com/post/50510962864/introducing-covim-collaborative-editing-for-vim) +- And [More!](http://fredkschott.com/post/2013/05/introducing-covim-real-time-collaboration-for-vim/) ##Installation From 6638a5b79663cbbd5596bc045ac6b3674f2cac96 Mon Sep 17 00:00:00 2001 From: Jason Date: Sun, 26 Mar 2017 15:12:28 -0700 Subject: [PATCH 6/6] Fix markdown formatting --- README.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index de1fafc..e05e794 100644 --- a/README.md +++ b/README.md @@ -10,31 +10,31 @@ __Follow [@FredKSchott](http://www.twitter.com/fredkschott) for development news ![Demo Gif](http://i.imgur.com/CZeKkAI.gif "Demo Gif") -##Features +## Features - Allows multiple users to connect to the same document online - Displays collaborators with uniquely colored cursors - Works with your existing configuration - Easy to set up & use - And [More!](http://fredkschott.com/post/2013/05/introducing-covim-real-time-collaboration-for-vim/) -##Installation +## Installation CoVim requires a version of Vim compiled with python 2.5+. Visit [Troubleshooting](https://github.com/FredKSchott/CoVim/wiki#troubleshooting) if you're having trouble starting Vim. Also note that the Twisted & Argparse libraries can also be installed via apt-get & yum. -####Install With [Pathogen](https://github.com/tpope/vim-pathogen): +#### Install With [Pathogen](https://github.com/tpope/vim-pathogen): 1. `pip install twisted argparse service_identity` 2. `cd ~/.vim/bundle` 3. `git clone git://github.com/FredKSchott/CoVim.git` -####Install With [Vundle](https://github.com/gmarik/vundle): +#### Install With [Vundle](https://github.com/gmarik/vundle): 1. `pip install twisted argparse service_identity` 2. Add `Plugin 'FredKSchott/CoVim'` to your `~/.vimrc` 3. `vim +PluginInstall +qall` -####Install Manually: +#### Install Manually: 1. `pip install twisted argparse service_identity` 2. Add `CoVimClient.vim` & `CoVimServer.py` to `~/.vim/plugin/` @@ -47,28 +47,28 @@ Also note that the Twisted & Argparse libraries can also be installed via apt-ge > > If you're still having trouble, [visit the wiki](https://github.com/FredKSchott/CoVim/wiki) for additional troubleshooting & FAQ -##Usage +## Usage __To start a new CoVim server:__ `:CoVim start [port] [name]` (or, from the command line: `./CoVimServer.py [port]`) __To connect to a running server:__ `:CoVim connect [host address / 'localhost'] [port] [name]` __To disconnect:__ `:CoVim disconnect` __To quit Vim while CoVim is connected:__ `:CoVim quit` or `:qall!` -##Customization -####Add any the following to your .vimrc to customize CoVim: +## Customization +#### Add any the following to your .vimrc to customize CoVim: ``` let CoVim_default_name = "YOURNAME" let CoVim_default_port = "YOURPORT" ``` -##Links +## Links __[Announcement Post](http://www.fredkschott.com/post/50510962864/introducing-covim-collaborative-editing-for-vim)__ __[FAQ](https://github.com/FredKSchott/CoVim/wiki#faq)__ __[Troubleshooting](https://github.com/FredKSchott/CoVim/wiki#troubleshooting)__ -##Special Thanks +## Special Thanks Tufts Professor [Ming Chow](http://www.linkedin.com/in/mchow01) for leading the [Senior Capstone Project](http://tuftsdev.github.io/SoftwareEngineering/) that CoVim was born in. [![Analytics](https://ga-beacon.appspot.com/UA-39778226-2/CoVim/Readme.md)](https://github.com/igrigorik/ga-beacon)