Update docs for the new commands available

This commit is contained in:
lupoDharkael
2017-06-15 20:31:51 +02:00
parent 4277af806f
commit 5b3da2125a
4 changed files with 28 additions and 12 deletions

View File

@@ -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!

View File

@@ -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

Binary file not shown.

Before

Width:  |  Height:  |  Size: 46 KiB

After

Width:  |  Height:  |  Size: 29 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 58 KiB

After

Width:  |  Height:  |  Size: 42 KiB