Skip to content

Commit 8860e8c

Browse files
committed
Update README to recent 1.3.0 changes
1 parent 226460d commit 8860e8c

File tree

1 file changed

+17
-15
lines changed

1 file changed

+17
-15
lines changed

README.md

Lines changed: 17 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -32,9 +32,9 @@ Use [Package Control][] to [install][] "CSScheme".
3232
You can either create a new file with the **CSScheme: Create new \*Scheme file**
3333
commands, open a file with the `.csscheme`, `.scsscheme`, `.sasscheme` or
3434
`.styluscheme` extension or convert an existing `tmTheme` file using the
35-
**CSScheme: Convert to CSScheme** command. Conversion to other syntaxes is not
36-
supported at the moment and likely won't in the future. Please convert manually
37-
and to your own preferences.
35+
**CSScheme: Convert to CSScheme** command or build system. Conversion to other
36+
syntaxes is not supported at the moment and likely won't in the future. Please
37+
convert manually and to your own preferences.
3838

3939
Building (<kbd>ctrl+b</kbd> or <kbd>⌘b</kbd>) will convert the file to CSScheme,
4040
if necessary, and then into a `.tmTheme` file. Errors during conversion are
@@ -48,7 +48,7 @@ Things you *must* consider when using **CSScheme**:
4848
rules in a ruleset will show as the name for various color scheme editing
4949
tools after compilation. Sublime Text itself does not use it.
5050
- In order to create a `.hidden-tmTheme` file, you need to specify a global
51-
`@hidden: true;` rule. The converter will consume this rule and change the
51+
`@hidden true;` rule. The converter will consume this rule and change the
5252
output file's extension accordingly.
5353
- If you want a property to have no font styles you have to specify
5454
`fontStyle: none;`. This will be translated to
@@ -58,22 +58,24 @@ Things you *must* consider when using **CSScheme**:
5858
- Specifying a uuid (via `@uuid`) is optional because Sublime Text ignores it.
5959

6060

61-
Things you *must* consider additionally when using CSScheme with **SCSS** (or
62-
**SASS**):
61+
Things you *must* consider additionally when using CSScheme with **SCSS** or
62+
**SASS**:
6363

6464
- Make sure that `sass` is available on your PATH or adjust the path to the
6565
executable in the settings.
6666
- The SASS parser will not accept raw `#RRGGBBAA` hashes. You must enclose
6767
them in a string, e.g. `'#12345678'`, or just use the `rgba()` notation.
68-
- The SASS parser will also not work with the literal `-` subtract scope seletor
69-
operator, so you must escape it with a backslash if you want to use it (`\-`).
68+
- The SASS parser will also not work with several scope selector operators (`-`,
69+
`&`, `(`, `)`, `|`). You must escape these with a backslash.
70+
The same applies to scope-segments starting with a number.
7071

71-
CSScheme will take care of removing the backslash in the resulting color
72-
scheme file (an example can be found in the [example files](#example-files)).
73-
74-
*Note*: This used to be `'-'` but the SASS parser doesn't accept it anymore.
75-
If you use an older version of SASS, CSScheme will still convert the old `'-'`
76-
escape.
72+
CSScheme will take care of removing backslashes before emitting the final
73+
conversion result.
74+
Examples can be found in the [example files](#example-files)).
75+
76+
**Note**: Because the SASS parser does not know about the semantics of these
77+
operators, they will generally behave poorly when used in conjunction with
78+
scope nesting.
7779

7880

7981
Things you *must* consider additionally when using CSScheme with **stylus**:
@@ -172,7 +174,7 @@ gives some great insight on what is possible.
172174
- [**Example StyluScheme.scsscheme**](./Example StyluScheme.styluscheme)
173175

174176
If you would like to see a real world example, refer to the [Writerly Scheme][]
175-
by [@alehandrof][] which heavily uses Sass's `@import` to make a larger scheme
177+
by [@alehandrof][] which heavily uses SASS's `@import` to make a larger scheme
176178
more manageable.
177179

178180
[Writerly Scheme]: https://github.com/alehandrof/Writerly

0 commit comments

Comments
 (0)