Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
goodroot committed Dec 5, 2024
1 parent 00fad92 commit 54ef5a2
Showing 1 changed file with 15 additions and 2 deletions.
17 changes: 15 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,9 +74,22 @@ renameTable
::= 'RENAME' 'TABLE' oldName 'TO' newName
```

Next, run the `scripts/railroad.py` script to generate the SVG image.
Be sure to maintain proper indentation!

During its final output, a markdown image with the appropriate syntax is printed.
Next, run the `scripts/railroad.py [name]` script to generate the SVG image.

For example:

```shell
python3 scripts/railroad.py renameTable
```

During its final output, a markdown image with the appropriate syntax is printed:

```text
Copy the image syntax below and paste it into your markdown file:
![Diagram for renameTable](/images/docs/diagrams/renameTable.svg)
```

Copy this syntax and paste it into the markdown file where you want the diagram to appear.

Expand Down

0 comments on commit 54ef5a2

Please sign in to comment.