Skip to content

Commit 1e41e92

Browse files
committed
docs: add Requirements section and link to CONTRIBUTING.md
List VS Code version requirement and Patchloom CLI minimum version in a dedicated section. Replace inline Contributing instructions with a link to the full CONTRIBUTING.md guide. Signed-off-by: Sebastien Tardif <sebtardif@ncf.ca>
1 parent 5297948 commit 1e41e92

1 file changed

Lines changed: 6 additions & 3 deletions

File tree

README.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -155,15 +155,18 @@ File bugs and feature requests at [patchloom/patchloom-vscode/issues](https://gi
155155

156156
---
157157

158+
## Requirements
159+
160+
- VS Code 1.90 or newer (or compatible editors: Cursor, Windsurf, VSCodium)
161+
- [Patchloom CLI](https://github.com/patchloom/patchloom) 0.1.0 or newer
162+
158163
## Contributing
159164

160-
Requires Node.js 20 or newer.
165+
See [CONTRIBUTING.md](CONTRIBUTING.md) for the full guide. Quick start:
161166

162167
```bash
163168
npm install
164169
npm run check # full gate: compile + test + package
165170
```
166171

167172
Open the repo in VS Code and press `F5` to launch the Extension Development Host.
168-
169-
Run `npm run check` before every commit. It compiles, runs all unit tests, and packages the `.vsix`.

0 commit comments

Comments
 (0)