pogmommy/sway-screenshot
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

chore: added README

Browse source
This commit is contained in:
Gustavo Parreira 2022-11-09 21:39:09 +00:00
parent d3d467210b
commit 7240227a04
No known key found for this signature in database
GPG key ID: 461165CBB467DD30
1 changed files with 39 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

39
README Normal file
View file

@ -0,0 +1,39 @@
# Hyprshot
Hyprshot is an utility to easily take screenshot in Hyprland using your mouse.
It allows taking screenshots of windows, regions and monitors which are saved to a folder of your choosing and copied to your clipboard.
## Installation
### Manual
To install manually, simply clone this repo and copy/symlink the `hyprshot` script to a folder in your `PATH`:
```bash
$ git clone https://github.com/Gustash/hyprshot.git Hyprshot
$ ln -s $(pwd)/Hyprshot/hyprshot $HOME/.local/bin
$ chmod +x Hyprshot/hyprshot
```
## Usage
The simplest usage of Hyprshot is executing it with one of the available modes.
For example, to screenshot an open window:
```bash
$ hyprshot -m window
```
You can also skip saving the screenshot to a file, copying it only to the clipboard:
```bash
$ hyprshot -m output --clipboard-only
```
## Configuration
You can choose which directory Hyprshot will save screenshots in by setting an `HYPRSHOT_DIR` environment variable to your preferred location.
If `HYPRSHOT_DIR` is not set, Hyprshot will attempt to save to `XDG_PICTURES_DIR` and will further fallback to your home directory if this is also not available.