search

nobody-famous / alive-lsp

Language Server Protocol implementation for use with the Alive extension
81 stars 9 forks source link

Add README.md file #40

Closed davidmpaz closed 1 year ago

davidmpaz commented 1 year ago

Adds documentation on how to start/configure the language server.

Fix: #39

vindarel commented 1 year ago

Hi, I am no maintainer of this project and I am not a native English speaker… I submitted suggestions though, hope it helps / makes both of you gain time.

davidmpaz commented 1 year ago

Hey no problems! I am glad you did it, it is good to get things properly written to avoid misunderstandings later on 👍🏼

nobody-famous commented 1 year ago

Thanks for writing this up! Documentation definitely isn't my thing. :-) I'll have time to look at it more next week.

I'd remove the parts about the VSCode extension. This one should be editor agnostic, more for people trying to use it outside of VSCode. The readme in the extension's repo should cover how to configure it. I think it does? I should proably check it again. The extension downloads the latest release of the LSP server, so everything should happen mostly automatically. The main issue being installing the external libraries that are needed.

I'll most likely merge this PR and then update it. I need to add docs around what LSP features are implemented and what non-standard messages are used.

davidmpaz commented 1 year ago

Cool! Thanks for taking time for it.

The extension downloads the latest release of the LSP server

This one was unknown to me. Actually my first setup was with slimv so starting the server outside was not foreign to me.

Other thing was that in the Extension there were settings which make me think the same was required, like install path, server address, and port. I realise now it is most probably meant to be for more general use cases when multiple sessions can be open against a single running server.

Feel free to edit everything, I just manage to get everything up and running and thought to share my notes for the next one to come here looking around. The 'next one' most likely be myself in the near future :)

Cheers, David