Skip to content

Commit

Permalink
well played...
Browse files Browse the repository at this point in the history
  • Loading branch information
jonathanlermitage committed Jan 8, 2024
1 parent 532d61c commit c17276f
Show file tree
Hide file tree
Showing 895 changed files with 5 additions and 12,510 deletions.
956 changes: 0 additions & 956 deletions CHANGELOG.md

This file was deleted.

36 changes: 0 additions & 36 deletions CONTRIBUTION.md

This file was deleted.

1 change: 0 additions & 1 deletion KNOWN_ISSUES.md

This file was deleted.

123 changes: 0 additions & 123 deletions Makefile

This file was deleted.

47 changes: 2 additions & 45 deletions README.md
Expand Up @@ -14,57 +14,14 @@
<a href="https://github.com/jonathanlermitage/intellij-extra-icons-plugin/graphs/contributors"><img alt="number of contributors" src="https://img.shields.io/github/contributors/jonathanlermitage/intellij-extra-icons-plugin"/></a><br>
</p>

:warn: Some people decided to distribute my plugin with license requirement removed, without having the decency to tell me about it. No acknowledgement, simply a total lack of respect, while I allowed users to support me financially only if they wished to. I am working hard on this plugin since 2018, allowing users to explore the code and optionally support my work. So I had to make the difficult decision to stop distributing the source code. *Well played...*. :warn:

Intellij IDEA (Community and Ultimate) plugin that adds icons for files like Travis YML, Appveyor YML, Git sub-modules, etc.
You can also register your own icons in order to override file icons, but also all [IDE icons](https://jetbrains.design/intellij/resources/icons_list/) (including toolbars, menus, etc.). It works with all JetBrains products like IntelliJ (ultimate and community), PyCharm, WebStorm, DataGrip, etc.
To get started with this plugin, please see this [guide](docs/GET_STARTED.md).

1. [Download](#download)
2. [Build](#build)
3. [Contribution](#how-to-contribute)
4. [Known issues](#known-issues)
5. [License](#license)
6. [Credits](#contributors)
7. [Screenshots](#screenshots)

## Download

Download plugin from the [JetBrains marketplace](https://plugins.jetbrains.com/plugin/11058-extra-icons) or via your IDE: <kbd>File</kbd>, <kbd>Settings...</kbd>, <kbd>Plugins</kbd>, <kbd>Marketplace</kbd>.

## Build

Install a JDK17+. You should be able to start Gradle Wrapper (`gradlew`).
Take a look at the `Makefile` script: it contains useful commands to build, run and test the plugin, check for dependencies updates and some maintenance tasks. Show available commands by running `make help`.
You may also want to see the [development FAQ](./docs/DEV_FAQ.md) if you faced an issue.

### Optimizations

Optionally, you may want to install SVGO in order to optimize SVG icons. Install SVGO with `npm install -g svgo`, then optimize SVG files by running `make svgo`.

## How to contribute

Please see [CONTRIBUTION.md](CONTRIBUTION.md).

Nota: you can test icons with this [sample project](https://github.com/jonathanlermitage/intellij-extra-icons-plugin/tree/sample-project). This is a project with many empty files. It will help you to verify icon overrides.

## Known issues

Please see [KNOWN_ISSUES.md](KNOWN_ISSUES.md) and [GitHub open issues](https://github.com/jonathanlermitage/intellij-extra-icons-plugin/issues).

## License

MIT License. In other words, you can do what you want: this project is entirely OpenSource, Free and Gratis.
You only have to pay a subscription if you want to support my work by using the version that is published to the JetBrains marketplace. If you don't want to (or can't) support my work, you can still use old releases (up to 1.69), or package and install your own release for free. If you have any question, please see the [license FAQ](docs/LICENSE_FAQ.md).

## Contributors

* Please see the [contributors list](https://github.com/jonathanlermitage/intellij-extra-icons-plugin/graphs/contributors)

## Screenshots

![Dark Screenshot](docs/screenshots/intellijidea-ce_dark.png)

![Screenshot](docs/screenshots/intellijidea-ce.png)

![Config Panel Screenshot](docs/screenshots/config-panel.png)

![User Config Panel Screenshot](docs/screenshots/config-panel-user-tab.png)

0 comments on commit c17276f

Please sign in to comment.