Skip to content

Commit 36eaa45

Browse files
committed
Update README.md.
1 parent cc81797 commit 36eaa45

File tree

1 file changed

+23
-1
lines changed

1 file changed

+23
-1
lines changed

README.md

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,25 @@
11
# LanguageServer.NET
22

3-
A .NET Language Server library for VSCode. Work in progress.
3+
A .NET Language Server library for VSCode, and hopefully, might be used with other IDEs that support [MS Language Server Protocol](https://github.com/Microsoft/language-server-protocol/blob/master/protocol.md). Still work in progress and API is subject to changes.
4+
5+
![Screenshot of DemoLanguageServer](README.resource/Screenshot.gif)
6+
7+
Based on [CXuesong/JsonRpc.Standard](https://github.com/CXuesong/JsonRpc.Standard), this .NET Standard library intends to provide basic interfaces and data structures so that you can write a language server in C#, build it on .NET Core and, with the help of the client-side code of [Microsoft/vscode-languageserver-node](https://github.com/Microsoft/vscode-languageserver-node), use it in VSCode.
8+
9+
The library is now available on NuGet. To install the package, run the following command in the Package Manager Console
10+
11+
```powershell
12+
Install-Package CXuesong.LanguageServer.VsCode -Pre
13+
```
14+
15+
## To set up the demo
16+
17+
You may need Visual Studio 2017 to build the demo.
18+
19+
1. Open `DemoLanguageServer` in VS, choose `Debug` profile, and build the project.
20+
2. Open `Client\VsCode` folder in VSCode.
21+
3. Run `npm install` in the terminal.
22+
4. Press F5 and a new VSCode window should show.
23+
5. Open a folder in the new VSCode window, and create a new file.
24+
6. Change the file language to `Demo Language`
25+
7. Then your editor will work as shown in the screenshot. Enter `.net core` in the editor and see what happens.

0 commit comments

Comments
 (0)