Skip to content

Commit 144102f

Browse files
!+☈kingbang+rking@sharpsaw.org
authored andcommitted
Explain some of the features you get for "free"
(cherry picked from commit ec5e2f7c2f2341bfd156689ebb15fa84e9238de7) Conflicts: README.md README.md.erb
1 parent 7cb2182 commit 144102f

File tree

2 files changed

+25
-0
lines changed

2 files changed

+25
-0
lines changed

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,16 @@ Or, from within vim:
6767
- Diff: 10 details detailed.
6868
- Vim: 4 details detailed.
6969

70+
Note that for fully supported languages (Ruby), you get the whole experience of having the subtle color shades that fingerprint and lint the code when you glance at it.
71+
72+
For the lesser grades mentioned above, you should get a bit more, but know that the `syntax/[yourlang].vim` has to have enough semantic parsing to make this possible. If you want to go further, you can certainly get a patch in that enhances the syntax parsing inside vim-detailed's `colors/detailed.vim` file.
73+
74+
For all other languages, even the ones not listed above, you should at least get:
75+
- Rainbow parens/brackets/curlies (which can be very helpful when the syntax gets deep)
76+
- Quiet comments (grey, because "a comment is a lie waiting to happen")
77+
- Strings with gray background (so it looks like a solid chunk)
78+
- Muted colorcolumn (gray instead of GIANT LOUD RED)
79+
- A color palette somewhat consistent with the detailed ones
7080

7181
## Troubleshooting
7282

README.md.erb

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,21 @@
66

77
<%= `rake lang_stats` %>
88

9+
Note that for fully supported languages (Ruby), you get the whole experience of having the subtle color shades that fingerprint and lint the code when you glance at it.
10+
11+
For the lesser grades mentioned above, you should get a bit more, but know that the `syntax/[yourlang].vim` has to have enough semantic parsing to make this possible. If you want to go further, you can certainly get a patch in that enhances the syntax parsing inside vim-detailed's `colors/detailed.vim` file.
12+
13+
For all other languages, even the ones not listed above, you should at least get:
14+
- Rainbow parens/brackets/curlies (which can be very helpful when the syntax gets deep)
15+
- Quiet comments (grey, because "a comment is a lie waiting to happen")
16+
- Strings with gray background (so it looks like a solid chunk)
17+
- Muted colorcolumn (gray instead of GIANT LOUD RED)
18+
- A color palette somewhat consistent with the detailed ones
19+
20+
## Issues:
21+
22+
<%= `ghi list` %>
23+
924
## Troubleshooting
1025

1126
This is wrong:

0 commit comments

Comments
 (0)