Skip to content

Commit 116c8de

Browse files
committed
Added explainations to settings file and the readme
1 parent 22f2620 commit 116c8de

File tree

2 files changed

+10
-1
lines changed

2 files changed

+10
-1
lines changed

Diff for: colorcoder.sublime-settings

+5
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,17 @@
11
{
2+
//these scopes are highlighted by colorcoder, feel free to ADD new to the list
23
"scopes": ["colorize",
34
"entity.name",
45
"support.function",
56
"meta.function-call",
67
"variable.other"],
8+
//disable when using plug-ins which swap or modify the schemes themselves
79
"auto_apply_on_scheme_change": true,
810
"lightness":0.5,
911
"saturation":0.5,
12+
//this is the threshold of file size where colorcoder will turn itself off
1013
"max_size": 100000,
14+
//default highlighting engine makes undo work letter-by-letter, set this to false to have
15+
//word-by-word undo, but slower highlighting
1116
"use_fast_highlighting_but_undo_typing_letterwise": true
1217
}

Diff for: readme.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ Download the [zip-ball](https://github.com/vprimachenko/Sublime-Colorcoder/archi
1616

1717
To properly work Colorcoder need an appropriately modified color scheme. On the first run plugin will try its best to automatically modify your current scheme. :grey_exclamation: the plugin will not actually modify the scheme but create a modified copy in its own directory and apply it.
1818
You can use `Tools``Packages``Colorcoder`` Tweak Colorcode on current color scheme` (or <kbd>CTRL</kbd><kbd>SHIFT</kbd><kbd>P</kbd> it) to modify the colors a bit (you can change the lightness and saturation).
19+
Colorcoder also needs an "good" language definition, which it does not activate automatically but leave you the choise to do so, read below for more.
1920

2021
##Supported Languages
2122
As few language definitions provided by Sublime are insufficient for optimal Colorcoder results i bundle tailored definitions. So far its
@@ -57,9 +58,12 @@ it should be somewhere within first 50–100 lines
5758
</dict>
5859

5960
or modify the bundled `.tmLanguage` files, you probably would only need to replace the keywords
61+
6062
##Options
61-
Colorcoder allows you to specify white- and blacklist for file-types to highlight: the settings are `enabled_for` and `disabled_for`. If `enabled_for` is present in the config only those file-types will be highlighted, `disabled_for` wont be highlighted even if present in whitelist.
6263
You can turn the highlighting off per view via `View``Colorcode this view`.
6364
Colorcoder also might slow down the editor when highlighting huge files, so it will turn itself off once the file has exceeded the `max_size` (the check happens when you save the file or reactivate the view). You can force it to highlight the file nevertheless via said menu item (which will read `Colorcoding may hurt performance, File is large` now)
65+
Default (faster) highlighting method makes the undo work letterwise, you can change this by setting `use_fast_highlighting_but_undo_typing_letterwise` to false. Colorcoder will then use alternative engine, which does not interfer with undo, but work somewhat slower on large files. You might want to tune `max_size` lower then.
66+
Finally Colorcoder allows you to specify white- and blacklist for file-types to highlight: the settings are `enabled_for` and `disabled_for`. If `enabled_for` is present in the config only those file-types will be highlighted, `disabled_for` wont be highlighted even if present in whitelist.
67+
6468
##Contact
6569
You can reach me via email: [[email protected]](mailto:[email protected]), twitter: [@vprimachenko](https://twitter.com/vprimachenko) or visit the official irc channel [freenode.net#colorcoder](irc://irc.freenode.net/colorcoder) ([webchat](http://webchat.freenode.net/?channels=colorcoder)). If Colorcoder was usefull to you i greatly appreciate a donation via Bitcoin [1DzZ1thGTHubRzoxEeDCJnJZwgFpna6jQk](bitcoin:1DzZ1thGTHubRzoxEeDCJnJZwgFpna6jQk).

0 commit comments

Comments
 (0)