Skip to content

Commit

Permalink
Mention precise drom version
Browse files Browse the repository at this point in the history
  • Loading branch information
nberth committed Nov 2, 2023
1 parent 293e603 commit a5580b7
Showing 1 changed file with 13 additions and 7 deletions.
20 changes: 13 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,28 +67,34 @@ page](https://ocamlpro.github.io/superbol-studio-oss/sphinx/emacs).

## Building from Sources

You first need to install a few external dependencies to build the LSP server and the VSCode extension from sources.
You first need to install a few external dependencies to build the LSP
server and the VSCode extension from sources.

1. First, you need to install and initialize [opam](https://opam.ocaml.org/);
1. First, you need to install and initialize
[opam](https://opam.ocaml.org/);

1. Then you need a decent version of our build tool [drom](https://ocamlpro.github.io/drom/). The easiest way to have it running is via the following command:
1. Then you need a recent version of our build tool
[drom](https://ocamlpro.github.io/drom/)[^drom-version]. The
easiest way to have it running is via the following command:

```bash
opam pin add https://github.com/OCamlPro/drom.git
```

1. To build the VSCode extension, you also need to have [node.js](https://nodejs.org/), and install `yarn` via:
[^drom-version]: Current version is 0.9.2~dev3 (commit 63a5770).

1. To build the VSCode extension, you also need to have
[node.js](https://nodejs.org/), and install `yarn` via:

```bash
npm install yarn
```

1. After that, running `make` in the package's root directory should compile the LSP server, along with the VSCode extension.
1. After that, running `make` in the package's root directory should
compile the LSP server, along with the VSCode extension.

## Resources

* Website: https://ocamlpro.github.io/superbol-vscode-platform
* General Documentation: https://ocamlpro.github.io/superbol-vscode-platform/sphinx
* Sources: https://github.com/ocamlpro/superbol-vscode-platform


0 comments on commit a5580b7

Please sign in to comment.