Skip to content

Commit

Permalink
Improve README
Browse files Browse the repository at this point in the history
  • Loading branch information
efoerster committed Jul 1, 2019
1 parent 50891fc commit 2c6658d
Showing 1 changed file with 27 additions and 3 deletions.
30 changes: 27 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,19 @@ We provide an [extension](https://github.com/latex-lsp/texlab-vscode) for [Visua

Learn more about the project on our [website](https://texlab.netlify.com).

## Getting Started
## Installation

If you want to use the server with [Visual Studio Code](https://code.visualstudio.com), then you can simply install
our extension from the [marketplace](https://marketplace.visualstudio.com/items?itemName=efoerster.texlab).

For other [tools](https://microsoft.github.io/language-server-protocol/implementors/tools/)
implementing the [Language Server Protocol](https://microsoft.github.io/language-server-protocol),
we provide [precompiled binaries for Windows, Linux and macOS](https://github.com/latex-lsp/texlab/releases).
You can place them on any directory that is in your `PATH`, for example `/usr/local/bin`
on Linux and macOS. On Windows, you will need to install
[Microsoft Visual C++ Redistributable for Visual Studio 2015](https://aka.ms/vs/16/release/vc_redist.x64.exe) to run the server.

## Building

You will need to install the following dependencies to compile the server:

Expand All @@ -26,13 +38,25 @@ cd ..
cargo build --release
```

To use a local debug build with the [Visual Studio Code extension](https://github.com/latex-lsp/texlab-vscode), you should create a symbolic link:
## 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 creating a symbolic link:

| Platform | Symlink |
| ----------- | ---------------------------------------------------------------------------------- |
| Windows x64 | `texlab/target/debug/texlab.exe -> texlab-vscode/server/texlab-x86_64-windows.exe` |
| Linux x64 | `texlab/target/debug/texlab -> texlab-vscode/server/texlab-x86_64-linux` |
| macOS x64 | `texlab/target/debug/texlab -> texlab-vscode/server/texlab-x86_64-darwin` |
| Linux x64 | `texlab/target/debug/texlab -> texlab-vscode/server/texlab-x86_64-linux` |

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

Expand Down

0 comments on commit 2c6658d

Please sign in to comment.