diff options
Diffstat (limited to 'support/texlab/README.md')
-rw-r--r-- | support/texlab/README.md | 48 |
1 files changed, 48 insertions, 0 deletions
diff --git a/support/texlab/README.md b/support/texlab/README.md new file mode 100644 index 0000000000..24634bbd3f --- /dev/null +++ b/support/texlab/README.md @@ -0,0 +1,48 @@ +[![GitHub release](https://img.shields.io/github/release/latex-lsp/texlab)](https://github.com/latex-lsp/texlab/releases) +[![Arch Linux](https://img.shields.io/archlinux/v/community/x86_64/texlab)](https://www.archlinux.org/packages/community/x86_64/texlab/) +[![Rust](https://img.shields.io/badge/rustc-1.39%2B-blue)](https://blog.rust-lang.org/2019/11/07/Rust-1.39.0.html) +[![Build Status](https://dev.azure.com/latex-lsp/texlab/_apis/build/status/latex-lsp.texlab?branchName=master)](https://dev.azure.com/latex-lsp/texlab/_build/latest?definitionId=8&branchName=master) +[![Coverage](https://img.shields.io/azure-devops/coverage/latex-lsp/texlab/8.svg?logo=azuredevops)](https://dev.azure.com/latex-lsp/texlab/_build/latest?definitionId=8&branchName=master) +[![Dependabot](https://api.dependabot.com/badges/status?host=github&repo=latex-lsp/texlab)](https://dependabot.com) + +# TexLab + +A cross-platform implementation of the [Language Server Protocol](https://microsoft.github.io/language-server-protocol) +providing rich cross-editing support for the [LaTeX](https://www.latex-project.org/) typesetting system. +We provide an [extension](https://github.com/latex-lsp/texlab-vscode) for [Visual Studio Code](https://code.visualstudio.com). + +Learn more about the project on our [website](https://texlab.netlify.com). + +## Getting Started + +See the [installation chapter](https://texlab.netlify.com/docs) from our docs. + +## Building from Source + +You will need to install the following dependencies to compile the server: + +- [Rust (>= 1.39)](https://rustup.rs/) + +Then run the following command in the project folder: + +```shell +cargo build --release +``` + +## Development + +You can create a debug build by building the server without the `--release` flag. +The resulting build can be used with the [Visual Studio Code extension](https://github.com/latex-lsp/texlab-vscode) +by adding the absolute path of the `target/debug` folder to your `PATH` environment variable. + +TexLab has an extensive test suite of unit and integration tests. You can run them by executing + +```shell +cargo test --all +``` + +in the project folder. + +## Contributing + +See [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us. |