Better documentation

[DominikStransky]

Hey there!
Maybe I'm just dumb and didn't know where to look 😅 but I spent hours trying to figure out (by googling) how to enable static code analysis (like stylecop).

Then after having slept over it, the :OmniSharpCodeFormat command caught my eye and I was trying to figure out where omnisharp-vim gets its information for this command. So I started looking into the actual sources of omnisharp-vim where I did a "grep -iR indent" and found the test/example folder with an omnisharp.json. So I copied this file to my project and changed some settings to see if it works and, bam!, I finally got what I wanted (basically EnableEditorConfigSupport and EnableAnalyzersSupport), it's working 🍾 🕺 🙂 .

Would be nice if this would be a bit clearer from the main Readme. Besides that, this seems to be a great plugin - thanks!

[nickspoons]

Yeah some good wiki articles describing various config options are on my eternal Todo list.

Would you be interested in starting one off with your findings about the .omnisharp/omnisharp.json file?

Note that this is purely an OmniSharp-roslyn config file, it's not used by OmniSharp-vim at all.

[DominikStransky]

Hi, thanks for the fast answer.

Sure, I can help with that.
I think, just adding a few words and a link to the omnisharp-roslyn configuration options to the main page would already be enough.

If that's ok, I will create a corresponding pull request as soon as I find the time for it.

[nickspoons]

Yeah you're right that config page is pretty good, so a bit of an intro perhaps describing what kind of thing it covers, and a link?

Although that page doesn't mention .editorconfig which is well supported by the server, and overrides lots of the options listed there.