KShare/README.md

77 lines
3.4 KiB
Markdown
Raw Normal View History

2017-04-23 15:05:48 +02:00
# KShare
2019-05-07 19:32:53 +02:00
A [ShareX](https://getsharex.com/) inspired cross platform utility written with Qt.
Originally written by [ArsenArsen](https://github.com/ArsenArsen) and here enhanced with [these](https://github.com/Gurkengewuerz/KShare/projects/1) features.
2017-05-16 16:51:25 +02:00
2020-06-02 17:26:50 +02:00
## Buildstatus (Arch, Ubuntu/Debian and Windows (MXE))
**master**|**dev**
:-----:|:-----:
[![Build Status](https://giteaci.mc8051.de/api/badges/Gurkengewuerz/KShare/status.svg?ref=refs/heads/master)](https://giteaci.mc8051.de/Gurkengewuerz/KShare)| [![Build Status](https://giteaci.mc8051.de/api/badges/Gurkengewuerz/KShare/status.svg?ref=refs/heads/dev)](https://giteaci.mc8051.de/Gurkengewuerz/KShare)
[Artifacts](https://artifacts.mc8051.de/Gurkengewuerz/KShare)
2019-05-08 00:48:04 +02:00
2017-04-28 21:42:33 +02:00
## Screenshot
Made with KShare itself, of course :)
![](https://i.imgur.com/oJrCNkq.png)
2017-04-28 21:42:33 +02:00
2020-02-23 15:19:35 +01:00
## 🎉 Features
* 💻 open source
* 🪶 lightweight
* 🖧 cross-platform
* 🔍 magnifying lense for image capture
* ⌨️ customizable keyboard shortcuts
* ✒️ image annotation (_rectangle_, _ellipse_, _freehand_, _line_, _arrow_, _text_)
* 📂 upload screenshots, files, clipboard or text
* 🤏 color picker
* 📤 multiple destinations implemented (_imgur_, _gdrive_, _clipboard_)
* 🔧 custom uploader (_works perfectly with ![**php_filehost**](https://github.com/Gurkengewuerz/php_filehost)_)
* 🖌️ themes (_dark_, ![_breeze dark_, _breeze light_](https://github.com/Alexhuszagh/BreezeStyleSheets), ![_qdarkstyle_](https://github.com/ColinDuquesnoy/QDarkStyleSheet))
2017-04-29 23:45:22 +02:00
## Usage
2017-09-04 00:43:06 +02:00
Please note that KShare is not compatiable with Wayland due to some permission issues. Please use X.Org instead.
2017-04-29 23:45:22 +02:00
2017-04-23 17:44:46 +02:00
## Dependencies
* Qt 5 Widgets
* Qt 5 GUI
* Qt 5 Network
2019-05-07 22:52:25 +02:00
* Qt 5 Multimedia
2017-06-29 19:50:06 +02:00
* Qt 5 X11Extras | Winextras
2017-04-26 22:31:32 +02:00
* [QHotkey](https://github.com/Skycoder42/QHotkey)
* libavformat
* libavcodec
* libavutil
* libswscale
2017-09-13 09:53:12 +02:00
2017-07-14 18:49:00 +02:00
Additionally, on Linux, you require:
* XCB
* XCB xfixes
* XCB cursor
2019-05-16 00:29:05 +02:00
* Notifications Daemon with org.freedesktop.notifications DBus support (like dunst)
2017-04-23 17:44:46 +02:00
Despite the name implying so, this project does not depend on the KDE API at all.
2017-05-03 22:50:26 +02:00
## Install
2017-06-27 15:12:12 +02:00
|Distro|Link|
|:----:|:--:|
2020-02-23 17:45:07 +01:00
|Arch Linux (development)|[kshare-git](https://app.circleci.com/github/Gurkengewuerz/KShare/pipelines?branch=master)|
|Ubuntu/Debian (development)|[.deb](https://app.circleci.com/github/Gurkengewuerz/KShare/pipelines?branch=dev)|
2020-02-16 20:50:24 +01:00
|Windows (development)|[Installer](https://ci.appveyor.com/project/Gurkengewuerz/kshare/branch/dev/artifacts)|
|Arch Linux |[kshare](https://github.com/Gurkengewuerz/KShare/blob/master/packages/arch/Stable-KShare/PKGBUILD)|
2020-02-23 17:45:07 +01:00
|Ubuntu/Debian |[.deb](https://app.circleci.com/github/Gurkengewuerz/KShare/pipelines?branch=master)|
2020-02-16 20:50:24 +01:00
|Windows |[Installer](https://ci.appveyor.com/project/Gurkengewuerz/kshare/branch/master/artifacts)|
2017-06-27 15:12:12 +02:00
2017-06-27 20:03:14 +02:00
For other UNIX-like platforms, and MSYS2 (for Windows):
You have to obtain the dependencies though.
```bash
2020-02-16 20:50:24 +01:00
git clone --recursive https://github.com/Gurkengewuerz/KShare.git
2017-06-27 20:03:14 +02:00
cd KShare
2017-07-11 16:24:36 +02:00
qmake # Might be qmake-qt5 on your system
2017-06-27 20:03:14 +02:00
make
```
2017-09-08 14:42:08 +02:00
On systems with FFMpeg pre-3.1 you need to apply `OlderSystemFix.patch` to `src/recording/encoders/encoder.cpp`.
2017-06-29 19:50:06 +02:00
On systems with Qt pre-5.7 you need to install the Qt version from their website.
2020-02-16 20:50:24 +01:00
You can attempt to `curl https://raw.githubusercontent.com/Gurkengewuerz/KShare/master/install.sh | bash`
2018-01-20 22:27:51 +01:00
2019-05-07 19:32:53 +02:00
###### Started on 19th of April 2017 by [ArsenArsen](https://github.com/ArsenArsen) to bring some attention and improvement to Linux screenshotting.