Skip to content

Commit 1010a56

Browse files
doc: add more context for extension
1 parent 2194a44 commit 1010a56

File tree

1 file changed

+14
-1
lines changed

1 file changed

+14
-1
lines changed

README.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Note, code linting and code actions requires [setting up `sgconfig.yml`](https:/
1212

1313
## Requirements
1414

15-
- [ast-grep](https://ast-grep.github.io/)
15+
- [ast-grep](https://ast-grep.github.io/) binary in your path.
1616

1717
```bash
1818
# install via npm
@@ -25,6 +25,19 @@ cargo install ast-grep
2525
brew install ast-grep
2626
```
2727

28+
- setting up ast-grep project.
29+
30+
This is an optional step to enable code linting and code actions. It requires at least one file and one folder to work:
31+
32+
- `sgconfig.yml`, the [project configuration file](https://ast-grep.github.io/reference/sgconfig.html)
33+
- a directory storing rule files, conventionally `rules/`
34+
35+
You can also use the [command line tool](https://ast-grep.github.io/reference/cli/new.html) to set it up.
36+
37+
```bash
38+
ast-grep new
39+
```
40+
2841
## Extension Settings
2942

3043
This extension contributes the following settings:

0 commit comments

Comments
 (0)