JetBrains_intellij-platform.../.github/template-cleanup/README.md

# %NAME%

![Build](https://github.com/%REPOSITORY%/workflows/Build/badge.svg)
[![Version](https://img.shields.io/jetbrains/plugin/v/MARKETPLACE_ID.svg)](https://plugins.jetbrains.com/plugin/MARKETPLACE_ID)
[![Downloads](https://img.shields.io/jetbrains/plugin/d/MARKETPLACE_ID.svg)](https://plugins.jetbrains.com/plugin/MARKETPLACE_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) and [pluginName](./gradle.properties), as well as the [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 `MARKETPLACE_ID` in the above README badges. You can obtain it once the plugin is published to the marketplace.
- [ ] 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 the 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
GitHub Actions - template cleanup workflow 2020-06-17 19:06:57 +00:00			`# %NAME%`

rename project to IntelliJ Platform Pugin Template 2020-06-19 05:36:30 +00:00			`![Build](https://github.com/%REPOSITORY%/workflows/Build/badge.svg)`
README: clarify which id should be used for the badges 2024-06-13 08:21:27 +00:00			`[![Version](https://img.shields.io/jetbrains/plugin/v/MARKETPLACE_ID.svg)](https://plugins.jetbrains.com/plugin/MARKETPLACE_ID)`
			`[![Downloads](https://img.shields.io/jetbrains/plugin/d/MARKETPLACE_ID.svg)](https://plugins.jetbrains.com/plugin/MARKETPLACE_ID)`
Added JetBrains Plugin badges and TODO list for the end users 2020-07-01 15:42:29 +00:00
			`## Template ToDo list`
README Tip to watch repository 2020-07-01 15:57:51 +00:00			`- [x] Create a new [IntelliJ Platform Plugin Template][template] project.`
Known -> Familiar 2021-10-30 21:18:17 +00:00			`- [ ] Get familiar with the [template documentation][template].`
README: clarify which id should be used for the badges 2024-06-13 08:21:27 +00:00			`- [ ] Adjust the [pluginGroup](./gradle.properties) and [pluginName](./gradle.properties), as well as the [id](./src/main/resources/META-INF/plugin.xml) and [sources package](./src/main/kotlin).`
template-cleanup: add "plugin description" step with Tips link 2023-02-15 11:40:50 +00:00			- [ ] Adjust the plugin description in `README` (see [Tips][docs:plugin-description])
Update hints 2022-11-17 21:11:19 +00:00			`- [ ] Review the [Legal Agreements](https://plugins.jetbrains.com/docs/marketplace/legal-agreements.html?from=IJPluginTemplate).`
update links to SDK Docs 2021-01-21 10:10:06 +00:00			`- [ ] [Publish a plugin manually](https://plugins.jetbrains.com/docs/intellij/publishing-plugin.html?from=IJPluginTemplate) for the first time.`
README: clarify which id should be used for the badges 2024-06-13 08:21:27 +00:00			- [ ] Set the `MARKETPLACE_ID` in the above README badges. You can obtain it once the plugin is published to the marketplace.
Update hints 2022-11-17 21:11:19 +00:00			`- [ ] 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).`
README Tip to watch repository 2020-07-01 15:57:51 +00:00			`- [ ] 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.`
GitHub Actions - template cleanup workflow 2020-06-17 19:06:57 +00:00
			`<!-- Plugin description -->`
rename project to IntelliJ Platform Pugin Template 2020-06-19 05:36:30 +00:00			`This Fancy IntelliJ Platform Plugin is going to be your implementation of the brilliant ideas that you have.`
GitHub Actions - template cleanup workflow 2020-06-17 19:06:57 +00:00
Remove unnecessary new lines from the README 2020-09-07 11:37:36 +00:00			`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.`
GitHub Actions - template cleanup workflow 2020-06-17 19:06:57 +00:00
			To keep everything working, do not remove `<!-- ... -->` sections.
			`<!-- Plugin description end -->`

			`## Installation`

Spellchecking 2023-08-07 13:43:03 +00:00			`- Using the IDE built-in plugin system:`
GitHub Actions - template cleanup workflow 2020-06-17 19:06:57 +00:00
Template Cleanup: Update README 2021-01-11 12:14:04 +00:00			`<kbd>Settings/Preferences</kbd> > <kbd>Plugins</kbd> > <kbd>Marketplace</kbd> > <kbd>Search for "%NAME%"</kbd> >`
README: update text of button "Install" 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] https://github.com/JetBrains/intellij-community/commit/c254ba45cd173fa0a7f1608bd304c3374d5255a4 [2] https://github.com/JetBrains/intellij-community/commit/ebb07b0411334e5cfda948b17ecab3af19abd3f4 [3] https://github.com/JetBrains/intellij-community/blob/ebb07b0411334e5cfda948b17ecab3af19abd3f4/platform/platform-resources-en/src/messages/IdeBundle.properties#L1714 2023-07-22 18:46:18 +00:00			`<kbd>Install</kbd>`
GitHub Actions - template cleanup workflow 2020-06-17 19:06:57 +00:00
			`- Manually:`

			`Download the [latest release](https://github.com/%REPOSITORY%/releases/latest) and install it manually using`
Template Cleanup: Update README 2021-01-11 12:14:04 +00:00			`<kbd>Settings/Preferences</kbd> > <kbd>Plugins</kbd> > <kbd>⚙️</kbd> > <kbd>Install plugin from disk...</kbd>`
GitHub Actions - template cleanup workflow 2020-06-17 19:06:57 +00:00

			`---`
README Tip to watch repository 2020-07-01 15:57:51 +00:00			`Plugin based on the [IntelliJ Platform Plugin Template][template].`

			`[template]: https://github.com/JetBrains/intellij-platform-plugin-template`
README: add newline at end of file Some text editors (such as vim) automatically add a newline at end of files. `git diff` also treats absence of newline at end of file in a special way. Add a newline at end of file README.md generated by the template to make it more convenient to use. 2023-07-22 18:40:20 +00:00			`[docs:plugin-description]: https://plugins.jetbrains.com/docs/intellij/plugin-user-experience.html#plugin-description-and-presentation`