From e2eb5aee77010544a7c1cfe30588bcda7765772f Mon Sep 17 00:00:00 2001 From: lupoDharkael Date: Sun, 11 Jun 2017 18:02:27 +0200 Subject: [PATCH] Improve docs --- README.md | 12 +++++++----- docs/build.md | 1 - docs/dev/compilation.md | 9 ++++++++- docs/futureFeatures.md | 3 ++- 4 files changed, 17 insertions(+), 8 deletions(-) delete mode 100644 docs/build.md diff --git a/README.md b/README.md index 220a6b1b..77eaf1be 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/docs/build.md b/docs/build.md deleted file mode 100644 index a5a18a56..00000000 --- a/docs/build.md +++ /dev/null @@ -1 +0,0 @@ -# Building From Source diff --git a/docs/dev/compilation.md b/docs/dev/compilation.md index 5ff6dcb1..1732724d 100644 --- a/docs/dev/compilation.md +++ b/docs/dev/compilation.md @@ -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 diff --git a/docs/futureFeatures.md b/docs/futureFeatures.md index c3e1b155..971e039c 100644 --- a/docs/futureFeatures.md +++ b/docs/futureFeatures.md @@ -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.