From 9c9082d04ad07d6298cf221761ff101e1b5707ed Mon Sep 17 00:00:00 2001 From: Sage Vaillancourt Date: Fri, 4 Apr 2025 14:17:08 -0400 Subject: [PATCH] Tweak the README I'm not sure what best practice is on this. I don't want to steal any credit, but I also don't want to speak out of turn on Dayle's behalf. Hopefully this is a decent middle ground. --- README.md | 36 ++++++++++++++++++++++++++---------- 1 file changed, 26 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 0ff9a5d..4a255a8 100644 --- a/README.md +++ b/README.md @@ -5,9 +5,11 @@ [![Installs](https://img.shields.io/jetbrains/plugin/d/10267-rainglow-color-schemes.svg)](https://plugins.jetbrains.com/plugin/10267-rainglow-color-schemes) [![Version](https://img.shields.io/jetbrains/plugin/v/10267-rainglow-color-schemes.svg)](https://plugins.jetbrains.com/plugin/10267-rainglow-color-schemes) -Rainglow is a collection of color themes for a number of different editors and platforms. This repository consists of **320+ syntax and UI themes** for [JetBrains IDEs](https://www.jetbrains.com/) including PHPStorm, Webstorm and more. +Rainglow is a collection of color themes for a number of different editors and platforms. This repository consists of * +*320+ syntax and UI themes** for [JetBrains IDEs](https://www.jetbrains.com/) including PHPStorm, Webstorm and more. -Please note that these themes use the [Material Darker](https://github.com/ChrisRM/material-theme-jetbrains) theme by [Chris Magnussen](https://github.com/ChrisRM) as a base for compatibility. Thanks for all your hard work Chris! +Please note that these themes use the [Material Darker](https://github.com/ChrisRM/material-theme-jetbrains) theme +by [Chris Magnussen](https://github.com/ChrisRM) as a base for compatibility. Thanks for all your hard work Chris! @@ -27,24 +29,38 @@ To show support for the project, you can do any (or many!) of the following: ### Easy Installation -Go to your IDE's settings, select `Plugins -> Browse Repositories...` search for and install 'Rainglow Color Schemes'. Restart your IDE, and the themes will be available within the Colour Schemes drop down within the settings dialog. Enjoy! +Go to your IDE's settings, select `Plugins -> Browse Repositories...` search for and install 'RainglowColorSchemes'. +Restart your IDE, and the themes will be available within the Colour Schemes drop down within the settings dialog. +Enjoy! ### Semi-Manual Installation -Navigate to the Plugins section of your IDE's settings dialog, and choose to install a plugin from disk. Install using the `rainglow.jar` file from the repository. Restart your IDE, and the themes will be available within the Colour Schemes drop down within the settings dialog. Enjoy! +Cloning the repo and running `make` will generate a file named `rainglow.jar` that contains the plugin. + +Navigate to the Plugins section of your IDE's settings dialog, and choose to install a plugin from disk. Install using +your new `rainglow.jar` file. Restart your IDE, and the themes will be available within the Colour Schemes drop down +within the settings dialog. Enjoy! ### Notes -JetBrains IDE's are a little painful to theme due to the amount of flexibility and language support they have. These color schemes will not look exactly like the themes for Sublime or jetbrains. Instead, I've found the best theme layout possible within JetBrains rendering ability. Please don't complain if they don't look exactly like the jetbrains themes! +JetBrains IDE's are a little painful to theme due to the amount of flexibility and language support they have. These +color schemes will not look exactly like the themes for Sublime or jetbrains. Instead, I've found the best theme layout +possible within JetBrains rendering ability. Please don't complain if they don't look exactly like the jetbrains themes! -Also note that these are only syntax colour schemes. To pimp your IDE UI, I highly recommend the [Material Theme for JetBrains](https://github.com/ChrisRM/material-theme-jetbrains) plugin from Chris Magnussen. It's a beautiful UI theme that you can see in the provided example screenshots. +Also note that these are only syntax colour schemes. To deck out your IDE UI, I highly recommend +the [Material Theme for JetBrains](https://github.com/ChrisRM/material-theme-jetbrains) plugin from Chris Magnussen. +It's a beautiful UI theme that you can see in the provided example screenshots. ### Useful Information -This project is an evolution of my colour schemes project found at [https://github.com/daylerees/colour-schemes](https://github.com/daylerees/colour-schemes). Peacock was the first ever theme. I created it to try and find something to use other than Monokai. It's now a favourite for many users! +This project is an evolution of Dayle's colour schemes project found +at [https://github.com/daylerees/colour-schemes](https://github.com/daylerees/colour-schemes). Peacock was the first +ever theme. It was created to try and find something to use other than Monokai. It's now a favourite for many users! -If you'd like to report a bug with one of the color schemes, please raise an issue on the repository rather than submitting a pull request. This is because the themes run through a generation process, and editing the themes directly is not advised! +If you'd like to report a bug with one of the color schemes, please raise an issue on the repository rather than +submitting a pull request. This is because the themes run through a generation process, and editing the themes directly +is not advised! -Have a wonderful day! +"Have a wonderful day!" -Dayle. + \- Dayle