Skip to content

Commit 0aecd90

Browse files
author
Quintin Willison
committed
Document our use of EditorConfig in the readme.
1 parent 679c3d3 commit 0aecd90

1 file changed

Lines changed: 5 additions & 0 deletions

File tree

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -497,6 +497,11 @@ You can run just the Checkstyle rules on their own using:
497497

498498
./gradlew checkstyleMain
499499

500+
We have a root [`.editorconfig`](.editorconfig) file, supporting [EditorConfig](https://editorconfig.org/), which should be of assistance within most IDEs. e.g.:
501+
502+
- [VS Code](https://code.visualstudio.com/) using the [EditorConfig plugin](https://marketplace.visualstudio.com/items?itemName=EditorConfig.EditorConfig)
503+
- [IntelliJ IDEA](https://www.jetbrains.com/idea/) using the [bundled plugin](https://www.jetbrains.com/help/idea/configuring-code-style.html#editorconfig).
504+
500505
## Tests
501506

502507
A gradle wrapper is included so these tasks can run without any prior installation of gradle. The Linux/OSX form of the commands, given below, is:

0 commit comments

Comments
 (0)