You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/contributing/CONTRIBUTING.md
+3-3Lines changed: 3 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,7 @@
1
1
# Contributing
2
2
3
3
Welcome! So glad you've decided to help make Cursorless better. Once you've
4
-
learned how to [install](#installation) and [run / test a local copy of the
4
+
learned how to [set up](#initial-setup) and [run / test a local copy of the
5
5
extension](#running--testing-extension-locally), you may want to check out the
6
6
[Cursorless API docs](api) to learn more about how Cursorless works. You may also find the [VSCode API docs](https://code.visualstudio.com/api) helpful to learn about VSCode extension development.
7
7
@@ -30,8 +30,8 @@ Extension" or "Extension Tests".
30
30
31
31
We use [`pre-commit`](https://pre-commit.com/) to automate autoformatting.
32
32
Autoformatters will automatically run on PRs in CI, but you can also run them
33
-
locally or install pre-commit hooks as described in the`pre-commit`
34
-
documentation.
33
+
locally or install pre-commit hooks as described in the
Copy file name to clipboardExpand all lines: docs/user/README.md
+31-25Lines changed: 31 additions & 25 deletions
Original file line number
Diff line number
Diff line change
@@ -14,7 +14,9 @@ Note: If you'd like to customize any of the spoken forms, please see the [docume
14
14
15
15
## Overview
16
16
17
-
Every cursorless command consists of an action performed on a target. For example, the command `"chuck blue air"` deletes the token with a blue hat over the `"a"`. In this command, the action is `"chuck"` (delete), and the target is `"blue air"`. There are no actions without at least one target.
17
+
Every cursorless command consists of an action performed on a target. For example, the command `"chuck bat"` deletes the token with a hat over the `b`. In this command, the action is `"chuck"` (delete), and the target is `"bat"`. There are no actions without at least one target.
18
+
19
+

18
20
19
21
## Targets
20
22
@@ -47,43 +49,47 @@ Combining this with an action, we might say `"take blue air"` to select the toke
47
49
48
50
###### Colors
49
51
50
-
The following colors are supported:
52
+
The following colors are supported. Note that to target the default (gray) hat you don't need to specify a color.
51
53
52
-
| Spoken form | Visible color | Internal ID |
53
-
| ----------- | ------------- | ----------- |
54
-
|`"blue"`| Blue |`blue`|
55
-
|`"green"`| Green |`green`|
56
-
|`"rose"`| Red |`rose`|
57
-
|`"squash"`| Yellow |`yellow`|
58
-
|`"plum"`| Pink |`pink`|
54
+
| Spoken form | Color | Internal ID | Enabled by default? |
You can enable or disable colors in your VSCode settings, by searching for `cursorless.hatEnablement.colors` and checking the box next to the internal ID for the given shape as listed above.
61
66
62
67
You can also tweak the visible colors for any of these colors in your VSCode settings, by searching for `cursorless.colors` and changing the hex color code next to the internal ID for the given shape as listed above. Note that you can configure different colors for dark and light themes.
63
68
64
69
If you find these color names unintuitive / tough to remember, their
65
70
spoken forms can be [customized](customization.md) like any other spoken form
66
-
in cursorless. If you change a spoken form to be more than one syllable, you
71
+
in Cursorless. If you change a spoken form to be more than one syllable, you
67
72
can change the penalty in the `cursorless.hatPenalties.colors` setting to the
68
-
number of syllables you use, so that cursorless can optimize hat allocation to
73
+
number of syllables you use, so that Cursorless can optimize hat allocation to
69
74
minimize syllables.
70
75
71
76
###### Shapes
72
77
73
-
The following shapes are supported:
74
-
75
-
| Spoken form | Internal ID | Shape | Enabled by default? |
You can enable or disable shapes in your VSCode settings, by searching for `cursorless.hatEnablement.shapes` and checking the box next to the internal ID for the given shape as listed above.
0 commit comments