Add an accompanying generated comment for better identification

[detj]

Is your feature request related to a problem? Please describe.

The way I see it, Alacritty encourages its users to fiddle around and manage its configuration by editing the Alacritty config file as they see fit. And alacritty-themes is essentially a yaml file patcher, patching the correct "colors" dictionary in the Alacritty config file, as per the user's input.

As of today, there is no way for users to notice and remember that these modifications was made automatically for them by a tool. They may not remember later if they had copy/pasted the colors manually or how it was updated.

Describe the solution you'd like

Leaving a comment may remind the user that they have the option to use alacritty-themes again to change the theme, without manually needed to make the edits.

I would say it is generally a good etiquette for a bot/program to communicate and let humans know that it made the edit. This way users are comfortably aware that they are not the only one editing the config file. As a side-effect, the comment can be used to provide additional instructions and so on for the user. It also looks cleaner & structured.

before

after

Don't have much opinion on the comment message. Change it accordingly.

Describe alternatives you've considered

Alternative would be to not add any yaml comments. If there is a good reason not do add any, would certainly like to know. But then the problem remains that one cannot tell just by looking at the Alacritty config file, who made the color edits.

Additional context There is no apparent harm if the user deletes the comment, or modifies it. alacritty-themes can choose to gracefully handle that situation. But then again, I would argue most users will not mind an auto-generated comment and would leave it as is. Goes without saying that alacritty-themes should not duplicate the comment. That would be terrible.

[JuanVqz]

Hi @detj! As an Alacritty user, I can say I don't like "extra" comments in my alacritty.yml file but I know there are several people that could love it because that way they can remember in the future how they generated/change the current theme

to me, it's a hard choice.

Thank you for your time exploring options to improve alacritty-themes :+1:

[JuanVqz]

If anyone has an idea how to implement this in the future feel free to open a new issue/pr.