KShare/README.md

# KShare
A [ShareX](https://getsharex.com/) inspired cross platform utility written with Qt.

|Linux|Windows|OS X|
|:---:|:-----:|:--:|
|[![Build Status](https://nativeci.arsenarsen.com/job/KShare/badge/icon)](https://nativeci.arsenarsen.com/job/KShare)| [![Build Status](https://nativeci.arsenarsen.com/job/KShare%20Windows%20x86_64/badge/icon)](https://nativeci.arsenarsen.com/job/KShare%20Windows%20x86_64/)| Soon |
## Screenshot
Made with KShare itself, of course :)

![](http://i.imgur.com/ffWvCun.png)

## Usage
See the [wiki](https://gitlab.com/ArsenArsen/KShare/wikis/home).

## Dependencies
* Qt 5 Widgets
* Qt 5 GUI
* Qt 5 Network
* Qt 5 X11Extras | Winextras
* [QHotkey](https://github.com/Skycoder42/QHotkey)
* libavformat
* libavcodec
* libavutil
* libswscale

Despite the name implying so, this project does not depend on the KDE API at all.

## Goals
See the [project board](https://gitlab.com/ArsenArsen/KShare/boards)

## Install

### **NOTE:** These links are temporarily down and will be fixed with the next release. Current (potentially unstable) development builds are available at [this location](https://nativeci.arsenarsen.com/job/KShare%20(dev))

|Distro|Link|
|:----:|:--:|
|Arch Linux (development)|[kshare-git](https://aur.archlinux.org/packages/kshare-git/)|
|Ubuntu (development)|[Ubuntu .deb](https://nativeci.arsenarsen.com/job/KShare/lastSuccessfulBuild/artifact/packages/simpleName.deb)|
|Arch Linux |[kshare](https://aur.archlinux.org/packages/kshare/)|
|Ubuntu |[Ubuntu .deb](https://nativeci.arsenarsen.com/job/KShare%20Stable/lastSuccessfulBuild/artifact/packages/simpleName.deb)|

I do plan to make a Debian packages.

For other UNIX-like platforms, and MSYS2 (for Windows):

You have to obtain the dependencies though.
```bash
git clone https://gitlab.com/ArsenArsen/KShare.git
cd KShare
qmake // Might be qmake-qt5 on your system
make
```

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.

## Support (and contact)
There's a few ways to get support, you can:
* join `#kshare` on [Freenode](https://webchat.freenode.net/?channels=kshare)
* open an issue

If someone can answer, they probably will.

###### Started on 19th of April 2017 to bring some attention and improvement to Linux screenshotting.
Initial 2017-04-23 15:05:48 +02:00			`# KShare`
Update README.md 2017-04-28 16:23:31 +02:00			`A [ShareX](https://getsharex.com/) inspired cross platform utility written with Qt.`
Or not 2017-05-16 16:51:25 +02:00
Fix build statuses 2017-05-16 16:51:02 +02:00			`\|Linux\|Windows\|OS X\|`
			`\|:---:\|:-----:\|:--:\|`
			`\|[![Build Status](https://nativeci.arsenarsen.com/job/KShare/badge/icon)](https://nativeci.arsenarsen.com/job/KShare)\| [![Build Status](https://nativeci.arsenarsen.com/job/KShare%20Windows%20x86_64/badge/icon)](https://nativeci.arsenarsen.com/job/KShare%20Windows%20x86_64/)\| Soon \|`
Update README.md 2017-04-28 21:42:33 +02:00			`## Screenshot`
Workaround for older systems 2017-06-29 19:50:06 +02:00			`Made with KShare itself, of course :)`
Update README.md 2018-02-13 16:29:56 +01:00
Merge branch 'master' into feature/recording 2017-06-13 12:11:03 +02:00			`![](http://i.imgur.com/ffWvCun.png)`
Update README.md 2017-04-28 21:42:33 +02:00
Update README.md 2017-04-29 23:45:22 +02:00			`## Usage`
So apparently the GitLab wiki pages are slightly different. 2018-07-13 00:18:39 +02:00			`See the [wiki](https://gitlab.com/ArsenArsen/KShare/wikis/home).`
Update README.md 2017-04-29 23:45:22 +02:00
Update README 2017-04-23 17:44:46 +02:00			`## Dependencies`
			`* Qt 5 Widgets`
			`* Qt 5 GUI`
			`* Qt 5 Network`
Workaround for older systems 2017-06-29 19:50:06 +02:00			`* Qt 5 X11Extras \| Winextras`
Update README.md 2017-04-26 22:31:32 +02:00			`* [QHotkey](https://github.com/Skycoder42/QHotkey)`
Yay encoding works!!!! Implemented a universal encoder based on FFMpeg. I'll get it to work with gif too. Adding other formats should be easy. In fact, recordingformats can be made into something much shorter. Soon:tm: 2017-06-13 00:38:32 +02:00			`* libavformat`
			`* libavcodec`
			`* libavutil`
			`* libswscale`
Update README 2017-04-23 17:44:46 +02:00
			`Despite the name implying so, this project does not depend on the KDE API at all.`

Initial 2017-04-23 15:05:48 +02:00			`## Goals`
Update most of the links to their GitLab alternative 2018-06-25 00:59:34 +02:00			`See the [project board](https://gitlab.com/ArsenArsen/KShare/boards)`
Hotkeys and crop improvements 2017-04-26 22:00:13 +02:00
Update README.md 2017-05-03 22:50:26 +02:00			`## Install`
Fix typo + wording Fixed a typo and re-worded the warning a bit. Also moved it up and made it a minor header instead of normal text so people don't miss it. 2018-01-25 06:38:24 +01:00
			`### NOTE: These links are temporarily down and will be fixed with the next release. Current (potentially unstable) development builds are available at [this location](https://nativeci.arsenarsen.com/job/KShare%20(dev))`

Update README.md 2017-06-27 15:12:12 +02:00			`\|Distro\|Link\|`
			`\|:----:\|:--:\|`
			`\|Arch Linux (development)\|[kshare-git](https://aur.archlinux.org/packages/kshare-git/)\|`
Update README.md 2017-06-27 19:59:42 +02:00			`\|Ubuntu (development)\|[Ubuntu .deb](https://nativeci.arsenarsen.com/job/KShare/lastSuccessfulBuild/artifact/packages/simpleName.deb)\|`
#19 2017-07-13 21:13:14 +02:00			`\|Arch Linux \|[kshare](https://aur.archlinux.org/packages/kshare/)\|`
add contact details 2018-01-20 22:31:06 +01:00			`\|Ubuntu \|[Ubuntu .deb](https://nativeci.arsenarsen.com/job/KShare%20Stable/lastSuccessfulBuild/artifact/packages/simpleName.deb)\|`

Workaround for older systems 2017-06-29 19:50:06 +02:00			`I do plan to make a Debian packages.`
Initial 2017-04-23 15:05:48 +02:00
Update README.md 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
Update most of the links to their GitLab alternative 2018-06-25 00:59:34 +02:00			`git clone https://gitlab.com/ArsenArsen/KShare.git`
Update README.md 2017-06-27 20:03:14 +02:00			`cd KShare`
			`qmake // Might be qmake-qt5 on your system`
			`make`
			```

Workaround for older systems 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.`

add contact details 2018-01-20 22:31:06 +01:00			`## Support (and contact)`
			`There's a few ways to get support, you can:`
Fix the newly added link 2018-01-20 22:34:09 +01:00			* join `#kshare` on [Freenode](https://webchat.freenode.net/?channels=kshare)
add contact details 2018-01-20 22:31:06 +01:00			`* open an issue`
Fix the newly added link 2018-01-20 22:34:09 +01:00
add contact details 2018-01-20 22:31:06 +01:00			`If someone can answer, they probably will.`

Initial 2017-04-23 15:05:48 +02:00			`###### Started on 19th of April 2017 to bring some attention and improvement to Linux screenshotting.`