Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[readme] Add info about our backported branches with Coq fixes #589

Merged
merged 1 commit into from
Oct 25, 2023
Merged

[readme] Add info about our backported branches with Coq fixes #589

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Assistant](https://coq.inria.fr). Experimental support for [Vim](#vim) and
**Quick Install**:
- **🐧 Linux / 🍎 macOs:**
```
$ opam install coq-lsp && code --install-extension ejgallego.coq-lsp`
$ opam install coq-lsp && code --install-extension ejgallego.coq-lsp
```
- **🪟 Windows:** Download the [Coq Platform installer](#-server)

Expand Down Expand Up @@ -318,6 +318,16 @@ See our [list of frequently-asked questions](./etc/FAQ.md).

## ⁉️ Troubleshooting and Known Problems

### Coq upstream bugs

Unfortunately Coq releases contain bugs that affect `coq-lsp`. We strongly
recommend that if you are installing via opam, you use the following branches
that have some fixes backported:

- For 8.18: `opam pin add coq-core https://github.com/ejgallego/coq.git#v8.18+lsp`
- For 8.17: `opam pin add coq-core https://github.com/ejgallego/coq.git#v8.17+lsp`
- For 8.16: `opam pin add coq https://github.com/ejgallego/coq.git#v8.16+lsp`

### Known problems

- Current rendering code can be slow with complex goals and messages, if that's
Expand Down
Loading