Skip to content

Commit

Permalink
Updated the documentation for the Shortcuts readme page (#608)
Browse files Browse the repository at this point in the history
* Updated the documentation for the Shortcuts readme page

* changed the empty mode from 'disabled' to 'unchaged' in the shortcut documentations

* minor fix to the shortcut readme file
  • Loading branch information
yotama9 authored Feb 14, 2024
1 parent 4fac5a9 commit dc732ee
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 7 deletions.
1 change: 1 addition & 0 deletions docs/docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ sidebar_position: 1
Visit [the downloads](/downloads) to download the app for your platform.
Use [web version](https://butterfly.linwood.dev) if you cannot find your platform.


## Main view

![Main view](main.png)
Expand Down
26 changes: 19 additions & 7 deletions docs/docs/shortcuts.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,15 +34,27 @@ Some of them are written below the buttons.
* `Ctrl` + `+`: Zoom in
* `Ctrl` + `-`: Zoom out

## Stylus
## Pen

By default, the the pen is configured to function as the following:
* `Pen`: configured as pen.
* `First` (Primary button, if supported): Change to hand tool while pressed.
* `Second` (Secondary button, if supported): Change to second tool (see [configure](#configure) section below) while pressed.


* `Primary button`: Change to hand tool
* `Secondary button`: Change to second tool

## Configure {#configure}

Customize the controls by giving every control a tool index.
You can customize the controls by giving every control a tool index. The tool indexing starts from the left of the toolbar, with `1` being the first index. See example below

![toolbar numbered](toolbar_numbered.png)

Here, 1 refers to the lasso tool, 2, to the pan tool etc.

The configure options you have are the following:

* Empty - the tool is unchaged.
* 0 - the tool will function as moving (i.e., hand) in this mod.
* Positive number - The tool will follow the indexing as explain above.


* Let it empty to disable the tool switch on this control.
* Set it to `0` to enable moving with this control.
* Set it to a positve number to switch to the tool with this index starting from the first on the left starting with `1`.
Binary file added docs/docs/toolbar_numbered.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit dc732ee

Please sign in to comment.