KShare/README.md

60 lines
2.4 KiB
Markdown
Raw Normal View History

2017-04-23 15:05:48 +02:00
# KShare
2017-04-28 16:23:31 +02:00
A [ShareX](https://getsharex.com/) inspired cross platform utility written with Qt.
2017-05-16 16:51:25 +02:00
2017-05-16 16:51:02 +02:00
|Linux|Windows|OS X|
|:---:|:-----:|:--:|
2017-07-22 11:35:55 +02:00
|[![Build Status](https://nativeci.arsenarsen.com/buildStatus/icon?job=KShare%20(dev)/main=master)](https://nativeci.arsenarsen.com/job/KShare%20(dev)/main=master/)|[![Build status](https://ci.appveyor.com/api/projects/status/7wa4f0bl6u62lo6v?svg=true)](https://ci.appveyor.com/project/ArsenArsen/kshare)|[![Build Status](https://nativeci.arsenarsen.com/buildStatus/icon?job=KShare%20(dev)/main=osxslave)](https://nativeci.arsenarsen.com/job/KShare%20(dev)/main=osxslave)|
2017-04-28 21:42:33 +02:00
## Screenshot
2017-06-29 19:50:06 +02:00
Made with KShare itself, of course :)
![](http://i.imgur.com/ffWvCun.png)
2017-04-28 21:42:33 +02:00
2017-04-29 23:45:22 +02:00
## Usage
See the [wiki](https://github.com/ArsenArsen/KShare/wiki).
2017-04-23 17:44:46 +02:00
## Dependencies
* Qt 5 Widgets
* Qt 5 GUI
* Qt 5 Network
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-07-14 18:49:00 +02:00
Additionally, on Linux, you require:
* XCB
* XCB xfixes
* XCB cursor
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-04-23 15:05:48 +02:00
## Goals
2017-04-28 16:26:05 +02:00
See the [projects](https://github.com/ArsenArsen/KShare/projects)
2017-04-26 22:00:13 +02:00
2017-05-03 22:50:26 +02:00
## Install
2017-06-27 15:12:12 +02:00
|Distro|Link|
|:----:|:--:|
|Arch Linux (development)|[kshare-git](https://aur.archlinux.org/packages/kshare-git/)|
2017-07-17 21:03:46 +02:00
|Ubuntu/Debian (development)|[.deb](https://nativeci.arsenarsen.com/job/KShare/lastSuccessfulBuild/artifact/packages/simpleName.deb)|
2017-07-13 21:13:14 +02:00
|Arch Linux |[kshare](https://aur.archlinux.org/packages/kshare/)|
2017-07-17 21:03:46 +02:00
|Ubuntu/Debian |[.deb](https://nativeci.arsenarsen.com/job/KShare%20Stable/lastSuccessfulBuild/artifact/packages/simpleName.deb )|
2017-06-27 15:12:12 +02:00
2017-06-29 19:50:06 +02:00
I do plan to make a Debian packages.
2017-04-23 15:05:48 +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
git clone https://github.com/ArsenArsen/KShare.git
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-06-29 19:50:06 +02:00
On systems with FFMpeg pre-3.1 you need to apply `OlderSystemFix.patch` to `recording/encoders/encoder.cpp`.
On systems with Qt pre-5.7 you need to install the Qt version from their website.
2017-07-11 16:24:36 +02:00
You can attempt to `curl https://raw.githubusercontent.com/ArsenArsen/KShare/master/install.sh | bash`
2017-07-13 17:29:29 +02:00
You can find more details [here](https://blog.arsenarsen.com/posts/compiling-kshare-on-linux-mac-os-x-and-windows-final-revision)
2017-04-23 15:05:48 +02:00
###### Started on 19th of April 2017 to bring some attention and improvement to Linux screenshotting.