From cdb2cb49e78b3a1fbfb96b5a79376de3308c4b36 Mon Sep 17 00:00:00 2001 From: Tad Hardesty Date: Fri, 31 Aug 2018 16:30:37 -0700 Subject: [PATCH] Move language server to top of readme --- README.md | 40 ++++++++++++++++++++-------------------- 1 file changed, 20 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index 7034e7ba..c418e3f7 100644 --- a/README.md +++ b/README.md @@ -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.