diff --git a/README.md b/README.md index 77eaf1be..3efdedba 100644 --- a/README.md +++ b/README.md @@ -2,13 +2,28 @@ > Powerfull yet simple to use screenshot software. ## Usage +Example commands: +- capture with GUI: -Add `flameshot-cli` to be executed as a shortcut. When you press the assigned key, Flameshot will be launched in the capture mode. +`flameshot gui` +- capture with GUI with custom save path: -A systray icon will be added to your panel after the first execution of Flameshot. +`flameshot gui -p ~/myStuff/captures` +- fullscreen capture (asking savepath): +`flameshot full` +- fullscreen capture with custom save path (no GUI): + +`flameshot full -p ~/myStuff/captures` +- fullscreen capture with custom save path copying to clipboard: + +`flameshot full -c -p ~/myStuff/captures` + +In case of doubt choose the first or the second shortcut in your favorite desktop environment. + +A systray icon will be in your system's panel while Flameshot is running. Do a right click on the tray icon and you'll see some menu items to open the configuration window and the information window. -Check out the information window to see all the available shortcuts in the capture mode. +Check out the information window to see all the available shortcuts in the graphical capture mode. ## Considerations @@ -18,13 +33,14 @@ Check out the information window to see all the available shortcuts in the captu - In order to speed up the first launch of Flameshot (DBus init of the app can be slow), consider starting an application automatically on boot. -- This software is very focused on selection capture and edition, but you can do full screen captures very easily just not having a visible selection, by default it will take it as if you were selecting the whole screen. +- Press `Enter` or `Ctrl + C` when you are in a capture mode and you don't have an active selection and the whole desktop will be copied to your clipboard! + +## Compilation and development + +- Information about manual compilation can be found [here](./docs/dev/compilation.md) - Check the [docs](./docs) folder for more information. -- Information about manual compilation can be found [here](./docs/dev/compilation.md)` - - ## Screenshots Dynamic button position based on your selection! diff --git a/docs/dev/compilation.md b/docs/dev/compilation.md index 1732724d..98e157b9 100644 --- a/docs/dev/compilation.md +++ b/docs/dev/compilation.md @@ -8,7 +8,7 @@ Dependencies: apt install -y git g++ build-essential qt5-qmake qt5-default ```` -Compilation: run `qmake && make` in the main directory and in `tools/flameshot-cli` +Compilation: run `qmake && make` in the main directory. ### Fedora Dependencies: @@ -16,7 +16,7 @@ Dependencies: dnf install -y qt5-devel gcc-c++ git qt5-qtbase-devel ```` -Compilation: run `qmake-qt5 && make` in the main directory and in `tools/flameshot-cli` +Compilation: run `qmake-qt5 && make` in the main directory. ### Arch Dependencies: @@ -24,7 +24,7 @@ Dependencies: pacman -S git qt5-base base-devel ```` -Compilation: run `qmake && make` in the main directory and in `tools/flameshot-cli` +Compilation: run `qmake && make` in the main directory. ## Install @@ -32,7 +32,7 @@ After the compilation you only have to add the DBus related files to its respect ```` cp dbus/org.dharkael.Flameshot.xml /usr/share/dbus-1/interfaces/ && \ -cp dbus/org.dharkael.Flameshot.service /usr/share/dbus-1/services/ && \ +cp dbus/org.dharkael.Flameshot.service /usr/share/dbus-1/services/ ```` -FInally add the compilled binaries to /usr/bin +Finally add the compilled binary to /usr/bin diff --git a/img/appScreenshots/screenshot_1.png b/img/appScreenshots/screenshot_1.png index 32763b35..8b72238d 100644 Binary files a/img/appScreenshots/screenshot_1.png and b/img/appScreenshots/screenshot_1.png differ diff --git a/img/appScreenshots/screenshot_2.png b/img/appScreenshots/screenshot_2.png index 799f3e55..f115230b 100644 Binary files a/img/appScreenshots/screenshot_2.png and b/img/appScreenshots/screenshot_2.png differ