Skip to content

Commit 504c357

Browse files
jeroenrinzemaauxten
authored andcommitted
updated the README to include instructions on code generation
1 parent bbd4830 commit 504c357

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

README.md

+10
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,16 @@ func main() {
6060

6161
```
6262

63+
# SQL parser
64+
65+
This project contains code that is automatically generated using `goyacc`.
66+
`goyacc` reads the SQL expressions ([`sql.y`](https://github.com/auxten/postgresql-parser/blob/main/pkg/sql/parser/sql.y)) and generates a parser which could be used to tokenize a given input.
67+
You could update the generated code using the `generate` target inside the project's Makefile.
68+
69+
```bash
70+
$ make generate
71+
```
72+
6373
### 🚧🚧🚧 still under construction 🚧🚧🚧
6474

6575
# Progress

0 commit comments

Comments
 (0)