diff --git a/README.md b/README.md index dc2b0cb977..52cb4b05d7 100644 --- a/README.md +++ b/README.md @@ -23,5 +23,9 @@ An easier way to reformat code is to set IntelliJ to do it on save. Go to `Settings -> Language & Frameworks -> JavaScript -> Prettier` and then check `Automatic Prettier Configuration`, set `Run for files` to `**/*.{java}`, and finally check `Run on save`. +For this to work you also need to have [Node.js](https://nodejs.org) +installed and configured under `Settings -> Language & Frameworks -> Node.js` +and the file you're saving *must* be able to compile otherwise no formatting +can be performed. The formatting is validated by CI, but you should do it beforehand with a simple `./mvnw verify -pl .`.