mirror of
https://github.com/JetBrains/intellij-platform-plugin-template.git
synced 2024-10-27 20:44:05 +00:00
da1f14e58a
The last step in instructions in the generated README.md file for
installing the plugin using IDE built-in plugin system is using the
button "Install Plugin". However, this button's text is "Install", at
least as of IntelliJ IDEA 2023.1. The text was "Install" since at least
the commit c254ba45cd17 ("IDEA-195193 Plugins: implement search",
2018-08-20) [1] where class InstallButton was introduced. Since commit
ebb07b041133 ("i18n for plugins configurable, initial", 2020-01-27) [2]
the class uses bundle message "action.AnActionButton.text.install" from
IdeBundle [3].
Change the text of the button in the generated README.md file to
"Install" accordingly.
[1] c254ba45cd
[2] ebb07b0411
[3] ebb07b0411/platform/platform-resources-en/src/messages/IdeBundle.properties (L1714)
45 lines
2.6 KiB
Markdown
45 lines
2.6 KiB
Markdown
# %NAME%
|
|
|
|
|
|
[](https://plugins.jetbrains.com/plugin/PLUGIN_ID)
|
|
[](https://plugins.jetbrains.com/plugin/PLUGIN_ID)
|
|
|
|
## Template ToDo list
|
|
- [x] Create a new [IntelliJ Platform Plugin Template][template] project.
|
|
- [ ] Get familiar with the [template documentation][template].
|
|
- [ ] Adjust the [pluginGroup](./gradle.properties), [plugin ID](./src/main/resources/META-INF/plugin.xml) and [sources package](./src/main/kotlin).
|
|
- [ ] Adjust the plugin description in `README` (see [Tips][docs:plugin-description])
|
|
- [ ] Review the [Legal Agreements](https://plugins.jetbrains.com/docs/marketplace/legal-agreements.html?from=IJPluginTemplate).
|
|
- [ ] [Publish a plugin manually](https://plugins.jetbrains.com/docs/intellij/publishing-plugin.html?from=IJPluginTemplate) for the first time.
|
|
- [ ] Set the `PLUGIN_ID` in the above README badges.
|
|
- [ ] Set the [Plugin Signing](https://plugins.jetbrains.com/docs/intellij/plugin-signing.html?from=IJPluginTemplate) related [secrets](https://github.com/JetBrains/intellij-platform-plugin-template#environment-variables).
|
|
- [ ] Set the [Deployment Token](https://plugins.jetbrains.com/docs/marketplace/plugin-upload.html?from=IJPluginTemplate).
|
|
- [ ] Click the <kbd>Watch</kbd> button on the top of the [IntelliJ Platform Plugin Template][template] to be notified about releases containing new features and fixes.
|
|
|
|
<!-- Plugin description -->
|
|
This Fancy IntelliJ Platform Plugin is going to be your implementation of the brilliant ideas that you have.
|
|
|
|
This specific section is a source for the [plugin.xml](/src/main/resources/META-INF/plugin.xml) file which will be extracted by the [Gradle](/build.gradle.kts) during the build process.
|
|
|
|
To keep everything working, do not remove `<!-- ... -->` sections.
|
|
<!-- Plugin description end -->
|
|
|
|
## Installation
|
|
|
|
- Using IDE built-in plugin system:
|
|
|
|
<kbd>Settings/Preferences</kbd> > <kbd>Plugins</kbd> > <kbd>Marketplace</kbd> > <kbd>Search for "%NAME%"</kbd> >
|
|
<kbd>Install</kbd>
|
|
|
|
- Manually:
|
|
|
|
Download the [latest release](https://github.com/%REPOSITORY%/releases/latest) and install it manually using
|
|
<kbd>Settings/Preferences</kbd> > <kbd>Plugins</kbd> > <kbd>⚙️</kbd> > <kbd>Install plugin from disk...</kbd>
|
|
|
|
|
|
---
|
|
Plugin based on the [IntelliJ Platform Plugin Template][template].
|
|
|
|
[template]: https://github.com/JetBrains/intellij-platform-plugin-template
|
|
[docs:plugin-description]: https://plugins.jetbrains.com/docs/intellij/plugin-user-experience.html#plugin-description-and-presentation
|