Skip to content

Commit e4a3b9c

Browse files
authored
More docs clarifications (#659)
1 parent 2d1a344 commit e4a3b9c

File tree

3 files changed

+34
-28
lines changed

3 files changed

+34
-28
lines changed

docs/contributing/CONTRIBUTING.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Contributing
22

33
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
55
extension](#running--testing-extension-locally), you may want to check out the
66
[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.
77

@@ -30,8 +30,8 @@ Extension" or "Extension Tests".
3030

3131
We use [`pre-commit`](https://pre-commit.com/) to automate autoformatting.
3232
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
34+
[`pre-commit` documentation](https://pre-commit.com/).
3535

3636
## Running docs site locally
3737

docs/user/README.md

Lines changed: 31 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,9 @@ Note: If you'd like to customize any of the spoken forms, please see the [docume
1414

1515
## Overview
1616

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+
![`"chuck bat"`](images/chuckBat.gif)
1820

1921
## Targets
2022

@@ -47,43 +49,47 @@ Combining this with an action, we might say `"take blue air"` to select the toke
4749

4850
###### Colors
4951

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.
5153

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? |
55+
| ----------- | ------- | ------------ | ------------------- |
56+
| N/A | grey | `default` ||
57+
| `"blue"` | blue | `blue` ||
58+
| `"green"` | green | `green` ||
59+
| `"red"` | red | `red` ||
60+
| `"pink"` | pink | `pink` ||
61+
| `"yellow"` | yellow | `yellow` ||
62+
| `"navy"` | navy | `userColor1` ||
63+
| `"apricot"` | apricot | `userColor2` ||
5964

6065
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.
6166

6267
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.
6368

6469
If you find these color names unintuitive / tough to remember, their
6570
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
6772
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
6974
minimize syllables.
7075

7176
###### Shapes
7277

73-
The following shapes are supported:
74-
75-
| Spoken form | Internal ID | Shape | Enabled by default? |
76-
| ----------- | ------------ | ----------------------------------------------- | ------------------- |
77-
| `"ex"` | `ex` | ![Ex](../../images/hats/ex.svg) ||
78-
| `"fox"` | `fox` | ![Fox](../../images/hats/fox.svg) ||
79-
| `"wing"` | `wing` | ![Wing](../../images/hats/wing.svg) ||
80-
| `"hole"` | `hole` | ![Hole](../../images/hats/hole.svg) ||
81-
| `"frame"` | `frame` | ![Frame](../../images/hats/frame.svg) ||
82-
| `"curve"` | `curve` | ![Curve](../../images/hats/curve.svg) ||
83-
| `"eye"` | `eye` | ![Eye](../../images/hats/eye.svg) ||
84-
| `"play"` | `play` | ![Play](../../images/hats/play.svg) ||
85-
| `"cross"` | `crosshairs` | ![Crosshairs](../../images/hats/crosshairs.svg) ||
86-
| `"bolt"` | `bolt` | ![Bolt](../../images/hats/bolt.svg) ||
78+
The following shapes are supported. Note that to target the default (dot) shape you don't need to specify a shape.
79+
80+
| Spoken form | Shape | Internal ID | Enabled by default? |
81+
| ----------- | ----------------------------------------------- | ------------ | ------------------- |
82+
| N/A | ![Default](../../images/hats/default.svg) | `default` ||
83+
| `"ex"` | ![Ex](../../images/hats/ex.svg) | `ex` ||
84+
| `"fox"` | ![Fox](../../images/hats/fox.svg) | `fox` ||
85+
| `"wing"` | ![Wing](../../images/hats/wing.svg) | `wing` ||
86+
| `"hole"` | ![Hole](../../images/hats/hole.svg) | `hole` ||
87+
| `"frame"` | ![Frame](../../images/hats/frame.svg) | `frame` ||
88+
| `"curve"` | ![Curve](../../images/hats/curve.svg) | `curve` ||
89+
| `"eye"` | ![Eye](../../images/hats/eye.svg) | `eye` ||
90+
| `"play"` | ![Play](../../images/hats/play.svg) | `play` ||
91+
| `"cross"` | ![Crosshairs](../../images/hats/crosshairs.svg) | `crosshairs` ||
92+
| `"bolt"` | ![Bolt](../../images/hats/bolt.svg) | `bolt` ||
8793

8894
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.
8995

docs/user/images/chuckBat.gif

19.3 KB
Loading

0 commit comments

Comments
 (0)