language-servers/SpacemanDMM
1
0
Fork 0
mirror of https://github.com/SpaceManiac/SpacemanDMM.git synced 2025-12-23 05:36:47 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Move language server to top of readme

Browse source
This commit is contained in:
Tad Hardesty 2018-08-31 16:30:37 -07:00
parent 1f595ed5db
commit cdb2cb49e7
1 changed files with 20 additions and 20 deletions
Download patch file Download diff file Expand all files Collapse all files

40
README.md
View file

@ -13,6 +13,26 @@ and on GitHub's issue tracker. Pull requests are welcome.
[/tg/station13]: https://github.com/tgstation/tgstation/
[releases]: https://github.com/SpaceManiac/SpacemanDMM/releases
## [Language Server](src/langserver/)
SpacemanDMM includes a [language server] providing autocomplete,
go-to-definition, and more for the DreamMaker language. The preferred
installation method is the [Visual Studio Code plugin][vsc], which will update
with newly-released language server binaries automatically. Details on
available features are listed in the language server's
[package readme][ls-readme].
The VS Code plugin is currently hosted in a [separate repository][vsc-src].
Use `cargo build -p dm-langserver` to build a local copy of the language server
for debugging or development purposes. The plugin can be configured to run a
locally built language server rather than the binary releases.
[language server]: https://langserver.org/
[vsc]: https://marketplace.visualstudio.com/items?itemName=platymuus.dm-langclient
[ls-readme]: ./src/langserver/README.md
[vsc-src]: https://github.com/SpaceManiac/vscode-dm-langclient
## [Map Renderer](src/cli/)
`dmm-tools` is SpacemanDMM's map renderer. It generates full-sized map images
@ -34,26 +54,6 @@ advised to run the resulting file through image optimization software such as
`pngcrush`. The `--pngcrush` option to the `minimap` subcommand can do this
automatically in many cases, but is off by default for speed reasons.
## [Language Server](src/langserver/)
SpacemanDMM includes a [language server] providing autocomplete,
go-to-definition, and more for the DreamMaker language. The preferred
installation method is the [Visual Studio Code plugin][vsc], which will update
with newly-released language server binaries automatically. Details on
available features are listed in the language server's
[package readme][ls-readme].
The VS Code plugin is currently hosted in a [separate repository][vsc-src].
Use `cargo build -p dm-langserver` to build a local copy of the language server
for debugging or development purposes. The plugin can be configured to run a
locally built language server rather than the binary releases.
[language server]: https://langserver.org/
[vsc]: https://marketplace.visualstudio.com/items?itemName=platymuus.dm-langclient
[ls-readme]: ./src/langserver/README.md
[vsc-src]: https://github.com/SpaceManiac/vscode-dm-langclient
## [Documentation Generator](src/dmdoc/)
`dmdoc` is a simple Doxygen-esque documentation generator for DreamMaker code.