Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                
Skip to content

Add Setup section to README #296

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 7, 2023
Merged

Add Setup section to README #296

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,20 @@

VSCode support for the [syntax_tree](https://github.com/ruby-syntax-tree/syntax_tree) gem. Available for download in the [VSCode marketplace](https://marketplace.visualstudio.com/items?itemName=ruby-syntax-tree.vscode-syntax-tree).

## Setup

After installing the [syntax_tree](https://github.com/ruby-syntax-tree/syntax_tree) gem and the [VSCode extension](https://marketplace.visualstudio.com/items?itemName=ruby-syntax-tree.vscode-syntax-tree), add the following to your VSCode `settings.json` to format Ruby on save.

```json
"[ruby]": {
"editor.formatOnSave": true,
"editor.defaultFormatter": "ruby-syntax-tree.vscode-syntax-tree"
},
```

You can find additional config options by searching for "syntax tree" in your VSCode settings.


## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/ruby-syntax-tree/vscode-syntax-tree.
Expand Down