Skip to content

Commit

Permalink
Merge pull request #1954 from erick2red/minor-docs-updates
Browse files Browse the repository at this point in the history
Minor documentation updates
  • Loading branch information
filipw authored Sep 23, 2020
2 parents 3ef6109 + 594e7d6 commit ed3d417
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion doc/Using-Omnisharp.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

OmniSharp is a C# based console application that has a rich API to support code intelligence for the C# language. With OmniSharp as the server, any text editor that supports plugins can be turned into a C# Development environment.

OnmiSharp requires a fully functioning .NET Core SDK installed and available from the path. You should able to run `dotnet --info` from Omnisharp's environment. Install a .NET Core SDK from: [https://aka.ms/dotnet-download](https://aka.ms/dotnet-download). If a custom installation is to be used, follow the instructions [here](https://docs.microsoft.com/en-us/dotnet/core/install/macos#download-and-manually-install).

This document is a rough overview of how to interact with OmniSharp, and what the various features are.

## Interfaces
Expand All @@ -21,7 +23,7 @@ When starting the server you must specify a solution file, or a directory where

OmniSharp.exe -s <solutionPath>

The server will detect the project and start up the project systems for the types of projects it finds.
The server will detect the project and start up the project systems for the types of projects it finds. There's no way of loading new projects after the server has started.

## Verbose logging
You can turn on verbose logging with the `-v` switch.
Expand All @@ -36,5 +38,10 @@ For historical reasons OmniSharp defaults to using one-based indices. That mea

OmniSharp.exe --zero-based-indices

## Configuration options

A detailed list of the exposed settings can be found in our [Wiki](wiki/Configuration-Options).


## Plugins
TODO: Plugins will be supported in the future

0 comments on commit ed3d417

Please sign in to comment.