From 9603facc1e0a9feb50d0f6c48b78a3a78d716d5c Mon Sep 17 00:00:00 2001 From: Emilio Jesus Gallego Arias <e+git@x80.org> Date: Wed, 25 Oct 2023 18:57:36 +0200 Subject: [PATCH] [readme] Add info about our backported branches with Coq fixes --- README.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 49538d43..ce577471 100644 --- a/README.md +++ b/README.md @@ -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) @@ -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