Skip to content

Commit 0be1fd6

Browse files
committed
Freshen up README
1 parent 59b9288 commit 0be1fd6

File tree

1 file changed

+26
-48
lines changed

1 file changed

+26
-48
lines changed

README.md

Lines changed: 26 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -9,48 +9,12 @@ OmniSharp-vim is a plugin for Vim to provide IDE like abilities for C#.
99

1010
OmniSharp works on Windows, and on Linux and OS X with Mono.
1111

12-
The plugin relies on the [OmniSharp-Roslyn](https://github.com/OmniSharp/omnisharp-roslyn) server, a .NET development platform used by several editors including Visual Studio Code, Emacs, Atom and others.
13-
14-
## New! Popups
15-
16-
Use Vim's popup windows and neovim's floating windows to display code/documentation without disrupting your window layouts: see [Popups](#popups) section for details and configuration options.
12+
The plugin relies on the [OmniSharp-Roslyn](https://github.com/OmniSharp/omnisharp-roslyn) server, a .NET development platform used by several editors including Visual Studio Code and Emacs.
1713

1814
![Popup Demo](https://raw.github.com/OmniSharp/omnisharp-vim/gh-pages/omnisharp-popup-demo.gif)
1915

2016
_(see the wiki [example config](https://github.com/OmniSharp/omnisharp-vim/wiki/Example-config) for a similar configuration to this demo)_
2117

22-
## New! Run unit tests
23-
24-
It is now possible to run unit tests via OmniSharp-roslyn, with success/failures listed in the quickfix window for easy navigation:
25-
26-
```vim
27-
" Run the current unit test (the cursor should be on/inside the test method)
28-
:OmniSharpRunTest
29-
30-
" Run all unit tests in the current file
31-
:OmniSharpRunTestsInFile
32-
33-
" Run all unit tests in the current file, and file `tests/test1.cs`
34-
:OmniSharpRunTestsInFile % tests/test1.cs
35-
```
36-
37-
**Note:** this is only available using the stdio server, and unfortunately does _not_ work in translated WSL, due to the way OmniSharp-roslyn runs the tests.
38-
39-
## Asynchronous server interactions over stdio
40-
41-
For vim8 and neovim, OmniSharp-vim uses the OmniSharp-roslyn stdio server instead of the older HTTP server, using pure vimscript (no python dependency!). All server operations are asynchronous and this results in a much smoother coding experience.
42-
43-
**Note:** neovim on Windows has been unable to communicate with the stdio server until a (very) recent neovim patch.
44-
If you are using nvim-qt _or_ terminal neovim on Windows, you will require a neovim [nightly build](https://github.com/neovim/neovim/releases/nightly) `NVIM v0.5.0-556` (2020-06-11) or newer, or will need to wait for neovim 0.5 to be released.
45-
46-
To use the HTTP server instead, add this to your .vimrc:
47-
48-
```vim
49-
let g:OmniSharp_server_stdio = 0
50-
```
51-
52-
Any time `g:OmniSharp_server_stdio` is modified, the server needs to be re-installed with `:OmniSharpInstall`.
53-
5418
## Features
5519

5620
* Contextual code completion
@@ -78,21 +42,17 @@ Any time `g:OmniSharp_server_stdio` is modified, the server needs to be re-insta
7842
* Code formatter
7943
* Run unit tests and navigate to failing assertions
8044

81-
## Screenshots
82-
#### Auto Complete
83-
![OmniSharp screenshot](https://f.cloud.github.com/assets/667194/514371/dc03e2bc-be56-11e2-9745-c3202335e5ab.png)
45+
## Asynchronous server interactions over stdio
8446

85-
#### Find Symbols
86-
![Find Symbols screenshot](https://raw.github.com/OmniSharp/omnisharp-vim/gh-pages/FindTypes.png)
47+
For vim8 and neovim, OmniSharp-vim uses the OmniSharp-roslyn stdio server instead of the older HTTP server, using pure vimscript (no python dependency!). All server operations are asynchronous and this results in a much smoother coding experience.
8748

88-
#### Find Usages
89-
![Find Usages screenshot](https://raw.github.com/OmniSharp/omnisharp-vim/gh-pages/FindUsages.png)
49+
To use the HTTP server instead, add this to your .vimrc:
9050

91-
#### Code Actions
92-
![Code Actions screenshot](https://raw.github.com/OmniSharp/omnisharp-vim/gh-pages/CodeActions.png)
51+
```vim
52+
let g:OmniSharp_server_stdio = 0
53+
```
9354

94-
#### Code Actions Available (see [wiki](https://github.com/OmniSharp/omnisharp-vim/wiki/Code-Actions-Available-flag) for details)
95-
![Code Actions Available](https://user-images.githubusercontent.com/5274565/38906320-1aa2d7c0-430a-11e8-9ee3-40790b7e600e.png)
55+
Any time `g:OmniSharp_server_stdio` is modified, the server needs to be re-installed with `:OmniSharpInstall`.
9656

9757
## Installation
9858
### Plugin
@@ -446,6 +406,24 @@ However "buffer" popups (previewing definitions and implementations) may be conf
446406
- `center`: Centered in the Vim window, filling the entire workspace.
447407

448408

409+
## Run unit tests
410+
411+
It is possible to run unit tests via OmniSharp-roslyn, with success/failures listed in the quickfix window for easy navigation:
412+
413+
```vim
414+
" Run the current unit test (the cursor should be on/inside the test method)
415+
:OmniSharpRunTest
416+
417+
" Run all unit tests in the current file
418+
:OmniSharpRunTestsInFile
419+
420+
" Run all unit tests in the current file, and file `tests/test1.cs`
421+
:OmniSharpRunTestsInFile % tests/test1.cs
422+
```
423+
424+
**Note:** this is only available using the stdio server, and unfortunately does _not_ work in translated WSL, due to the way OmniSharp-roslyn runs the tests.
425+
426+
449427
## Configuration
450428

451429
### Example vimrc

0 commit comments

Comments
 (0)