wynd
/
zoomie
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Added the README file

master
Wynd 2024-11-07 22:36:10 +02:00
parent 6fe6604c35
commit 1a8097be9b
1 changed files with 22 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md 100644
View File

@ -0,0 +1,22 @@
# zoomie
a zoomer app inspired by [tsoding's boomer](https://github.com/tsoding/boomer) but with support for wayland and written in rust.
## controls
| controls | description |
| ------------------------------------------------------------------ | ------------------------------------------------- |
| <kbd>Esc</kbd> | quit the app |
| drag using left click or move the cursor to the edge of the screen | move around |
| hold <kbd>Ctrl</kbd> | enables the spotlight effect and hides the cursor |
| scroll wheel | zooms in/out |
| <kbd>Ctrl</kbd> + scroll wheel | change the radius of the spotlight |
| <kbd>R</kbd> | resets the zoom and position |
## install
### from source using cargo
- clone the repository
- `cd` into the repository
- run `cargo install --path .`, cargo will build a release build and install it, for more info check the [cargo-install docs](https://doc.rust-lang.org/cargo/commands/cargo-install.html)