fergalmoran/flameshot
1
0
Fork 0
mirror of https://github.com/fergalmoran/flameshot.git synced 2026-01-04 08:07:00 +00:00
Code Issues Packages Projects Releases Wiki Activity

Improve docs

Browse Source
This commit is contained in:
lupoDharkael
2017-06-11 18:02:27 +02:00
parent 387773351c
commit e2eb5aee77
4 changed files with 17 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@@ -1,8 +1,6 @@
![image](./img/flameshot.png)
> Powerfull yet simple to use screenshot software.
**A beta will be released and packaged for the main GNU/Linux distros soon !**
## Usage
Add `flameshot-cli` to be executed as a shortcut. When you press the assigned key, Flameshot will be launched in the capture mode.
@@ -16,11 +14,15 @@ Check out the information window to see all the available shortcuts in the captu
**Not working on Wayland**
If you are using Gnome you need to install the [TopIcons](https://extensions.gnome.org/extension/495/topicons/) extension in order to see the systemtray icon.
- If you are using Gnome you need to install the [TopIcons](https://extensions.gnome.org/extension/495/topicons/) extension in order to see the systemtray icon.
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.
- 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.
Check the ./docs folder for more information.
- 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.
- Check the [docs](./docs) folder for more information.
- Information about manual compilation can be found [here](./docs/dev/compilation.md)`
## Screenshots

1
docs/build.md
View File

@@ -1 +0,0 @@
# Building From Source

9
docs/dev/compilation.md
View File

@@ -17,7 +17,14 @@ 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`
### Arch
Dependencies:
````
pacman -S git qt5-base base-devel
````
Compilation: run `qmake && make` in the main directory and in `tools/flameshot-cli`
## Install

3
docs/futureFeatures.md
View File

@@ -1,4 +1,5 @@
This will gather some possible features to implement in Flameshot.
This will gather some possible features to implement in Flameshot.
These are just conceptual and they may not be implemented implemented in a short period of time.
- Add Text Button: this could be very handy but requires a huge refactor of the source code.