Skip to content

Commit f5390ea

Browse files
TafferChris Herborth
andauthored
add Sublime Text info (#322)
Co-authored-by: Chris Herborth <chrish@taffer.ca>
1 parent 93edfec commit f5390ea

1 file changed

Lines changed: 13 additions & 0 deletions

File tree

‎README.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -334,6 +334,19 @@ auto-format = true
334334

335335
If you lose work because of the formatter, you can usually get it back with a simple "undo" (Cmd/Ctrl + Z). This will show you the "undo reload from disk" popup. You can also check the local history by right-clicking on the file in the project explorer and selecting `Local History > Show History`.
336336

337+
### Sublime Text
338+
339+
Using the SublimeLinter package, you can have GDScript-formatter lint your code
340+
as you work:
341+
342+
1. Install GDScript-formatter somewhere in your `$PATH`.
343+
2. In Sublime Text, [install Package Control](https://packagecontrol.io/installation) if you haven't already.
344+
3. Open the command palette by pressing Ctrl+Shift+p or Cmd+Shift+p if you're on a Mac, then choose "Package Control: Install Package".
345+
4. If you haven't already installed it, install the "GDScript" package so Sublime Text knows about `.gd` files.
346+
5. Install the "SublimeLinter-contrib-GDScriptFormatterLinter" package.
347+
348+
See the [GDScript-formatter-linter](https://worktree.ca/taffer/GDScript-formatter-linter) plugin's README for additional settings.
349+
337350
## Contributing
338351

339352
Contributions are welcome! I've compiled some guides and guidelines below to help you get started with contributing to the GDScript formatter. If you need more information or want to discuss ideas for the formatter, please get in touch on the [GDQuest Discord](https://discord.gg/87NNb3Z).

0 commit comments

Comments
 (0)