Skip to content

Commit 3aff82a

Browse files
committed
Update README with Related Papers and update future plans
1 parent cff44b9 commit 3aff82a

File tree

1 file changed

+12
-16
lines changed

1 file changed

+12
-16
lines changed

README.md

+12-16
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,14 @@
66

77
# Table of Contents
88

9-
- 🚀 [CoqPilot Overview](#coqpilot)
9+
- 🚀 [CoqPilot Overview](#coqpilot-version)
1010
- 📋 [Requirements](#requirements)
11+
- 📚 [Related papers](#related-papers)
1112
- 🔍 [Brief Technical Overview](#brief-technical-overview)
1213
- 💡 [Example Usage](#example-usage)
1314
- 🛠 [Installation](#installation)
1415
- ▶️ [Coq-LSP Installation](#coq-lsp-installation)
1516
- 🤖 [Building Locally](#building-locally)
16-
- ⚠️ [Important Information](#important)
1717
- ⚙️ [Extension Settings](#extension-settings)
1818
- 📐 [Guide to Model Configuration](#guide-to-model-configuration)
1919
- 🎛 [How VSCode settings work](#how-vscode-settings-work)
@@ -30,6 +30,16 @@
3030

3131
* `coq-lsp` version `0.2.2+8.19` is currently required to run the extension.
3232

33+
## Related papers
34+
35+
- **[ASE Demo'24]** *CoqPilot, a plugin for LLM-based generation of proofs*
36+
<br />
37+
[[Paper](https://dl.acm.org/doi/10.1145/3691620.3695357) | [arXiv](https://arxiv.org/abs/2410.19605) | [Video (5min)](https://www.youtube.com/watch?v=oB1Lx-So9Lo) | [Video (10min)](https://www.youtube.com/watch?v=P-LHXf7vntM)]
38+
- **[AITP'24 & CoqWS'24]** *CoqPilot, a plugin for LLM-based generation of proofs*
39+
<br />
40+
[[Extended Abstract](https://coq-workshop.gitlab.io/2024/files/EA2.pdf) | [CoqWS Slides](https://coq-workshop.gitlab.io/2024/files/SL2.pdf)]
41+
42+
3343
## Brief technical overview
3444

3545
`CoqPilot` fetches proofs from multiple completion services. Now we support:
@@ -108,19 +118,6 @@ To run specific tests, you can use `npm run test -- -g="grep pattern"`.
108118
109119
The extension's architecture overview is stored in the [ARCHITECTURE.md](https://github.com/JetBrains-Research/coqpilot/blob/refactor/ARCHITECTURE.md) file. It will be extended and updated as the project evolves. -->
110120

111-
## Important
112-
113-
CoqPilot generates aux files with `_cp_aux.v` suffix. Sometimes when generation fails with exception, it is possible that such file will not be deleted. When a project is open, extension shall show a window that asks if you want to add such files to the local project gitignore.
114-
115-
Moreover, this repository contains a script for your convenience that adds the format of such files to the global gitignore file on your system.
116-
- Copy the [`set_gitignore.sh`](https://github.com/JetBrains-Research/coqpilot/blob/main/set_gitignore.sh) file to your computer. Then:
117-
```bash
118-
chmod +x set_gitignore.sh
119-
./set_gitignore.sh
120-
```
121-
It will add the format of CoqPilot aux files to your global gitignore file on the system, so that even if CoqPilot forgets to clean files up, they will not be marked as new files in git.
122-
Comment: Such files are not visible in the VSCode explorer, because plugin adds them to the `files.exclude` setting on startup.
123-
124121
## Extension Settings
125122

126123
This extension contributes the following settings:
@@ -294,7 +291,6 @@ Then add the `hammer.`, `sauto.` or any other tactic from `CoqHammer` to the pre
294291
## Future plans
295292

296293
- Currently the user needs to manually enter the nix shell to get the correct environment for the benchmarks. We are working on automating this process.
297-
- Get rid of the overhead due to hacks with coq-lsp and the aux files.
298294

299295
## Release Notes
300296

0 commit comments

Comments
 (0)