Skip to content

Commit

Permalink
Merge pull request #961 from mattam82/update-dev-instructions
Browse files Browse the repository at this point in the history
Update developers.md with more info, allowing to use vscoq2 during de…
  • Loading branch information
rtetley authored Dec 10, 2024
2 parents 5c60b46 + 9a14c98 commit d1374e0
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions docs/developers.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,19 @@ If you have nix installed, you can do a full developer build of the language ser
nix develop .#vscoq-language-server -c bash -c "cd language-server && dune build"
```

### Composing the build with Coq

We assume you are in a directory `coq/` where you have a coq checkout (built or not).
You can git clone the vscoq repository in `coq/vscoq/` (next to, say, `kernel/`).
Then `dune build vscoq/language-server` will build the server, typically in
`_build/install/default/bin/vscoqtop` (next to the coq binaries).

In order to use this binary, point the `vscoq.path` option to that path (better in its absolute form).

Whenever you change the Coq sources `dune build` will also rebuild vscoqtop.
If you specify a more specific dune target, remember that vscoqtop is *linked* to Coq,
so if you don't rebuild it it will not work.

### Debugging

## Client
Expand All @@ -67,6 +80,9 @@ Both of the two coq exclusive panels are react apps. We use the [atomic design p
* Still from the client folder, run `yarn run build:all` this will ensure that both web apps are built.
* You can then run `yarn run compile` which will compile the extension.
* To package the extension run `yarn run package`
* To make an installable `.vsx` package, use `npm install -g @vscode/vsce` (once) and `vsce package`.
This package can be installed locally in any code workspace or all (not recommended, as it can overwrite an existing
globally installed vsx `code --install-extension vscoq-*.vsix`)
* For publishing to VSCode market place use the [vsce tool](https://code.visualstudio.com/api/working-with-extensions/publishing-extension)

### Debugging
Expand Down

0 comments on commit d1374e0

Please sign in to comment.