Skip to content

Commit f9eca5a

Browse files
plumpygoogle-java-format Team
authored and
google-java-format Team
committed
Update the README to point to JetBrains documentation where appropriate.
Fixes #1136 PiperOrigin-RevId: 666125973
1 parent 3fe163b commit f9eca5a

File tree

1 file changed

+10
-9
lines changed

1 file changed

+10
-9
lines changed

README.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -35,23 +35,24 @@ is available from the plugin repository. To install it, go to your IDE's
3535
settings and select the `Plugins` category. Click the `Marketplace` tab, search
3636
for the `google-java-format` plugin, and click the `Install` button.
3737

38-
The plugin will be disabled by default. To enable it in the current project, go
39-
to `File→Settings...→google-java-format Settings` (or `IntelliJ
40-
IDEA→Preferences...→Other Settings→google-java-format Settings` on macOS) and
41-
check the `Enable google-java-format` checkbox. (A notification will be
42-
presented when you first open a project offering to do this for you.)
38+
The plugin will be disabled by default. To enable,
39+
[open the Project settings](https://www.jetbrains.com/help/idea/configure-project-settings.html),
40+
then click "google-java-format Settings" and check the "Enable
41+
google-java-format" checkbox.
4342

44-
To enable it by default in new projects, use `File→Other Settings→Default
45-
Settings...`.
43+
To enable it by default in new projects,
44+
[open the default settings for new projects](https://www.jetbrains.com/help/idea/configure-project-settings.html#new-default-settings)
45+
and configure it under "Other Settings/google-java-format Settings".
4646

4747
When enabled, it will replace the normal `Reformat Code` and `Optimize Imports`
4848
actions.
4949

5050
#### IntelliJ JRE Config
5151

5252
The google-java-format plugin uses some internal classes that aren't available
53-
without extra configuration. To use the plugin, go to `Help→Edit Custom VM
54-
Options...` and paste in these lines:
53+
without extra configuration. To use the plugin, you need to
54+
[add some options to your IDE's Java runtime](https://www.jetbrains.com/help/idea/tuning-the-ide.html#procedure-jvm-options).
55+
To do that, go to `Help→Edit Custom VM Options...` and paste in these lines:
5556

5657
```
5758
--add-exports=jdk.compiler/com.sun.tools.javac.api=ALL-UNNAMED

0 commit comments

Comments
 (0)