cursorless-dev/cursorless
1
1
Fork 0
mirror of https://github.com/cursorless-dev/cursorless.git synced 2024-10-05 13:27:10 +03:00
Code Issues Packages Projects Releases Wiki Activity
7404d2b771
cursorless/README.md
Pokey Rule ff120118c5 Fix badges
2021-07-11 21:16:27 +01:00

2.3 KiB
Raw Blame History

Welcome to Cursorless!

Version Documentation Maintenance License: MIT

Allows cursorless editing and rapid navigation by decorating a single letter from each token.

Features

swap main-demo demo-2 demo-3

Checkout the docs, tutorial video and !!con talk to get started.

Installation

Currently depends on Talon, though a keyboard version is planned.

See cursorless-talon for installation instructions.

Extension Settings

This extension contributes the following settings:

  • cursorless.showOnStart: Whether decorations should appear on workspace start
  • cursorless.hatSizeAdjustment: Percentage to increase or decrease hat size; positive increases size
  • cursorless.hatVerticalOffset: How much to vertically shift the hats as a percentage of font size; positive is up

Known Issues

  • Cursorless calculates the position of the hats based on the characteristics of your font. If you find that the hats are off center you can try running this command: cursorless.recomputeDecorationStyles

Change Log

See CHANGELOG.md.

Contributing

Installation

yarn install

Running tests

yarn run test

This README was partially generated with ❤️ by readme-md-generator