Skip to content

Latest commit

 

History

History
69 lines (57 loc) · 3.4 KB

README.md

File metadata and controls

69 lines (57 loc) · 3.4 KB
Raw

owo.sh

A shell script for uploading and shortening links to owo.whats-th.is.

Dependencies

Dependency OS Notes
curl ALL N/A
maim Linux, BSD For FreeBSD users: version on FreshPorts is ancient
jq ALL Not required if python or ruby present
python ALL Not required if jq or ruby are present
ruby ALL Not required if jq or python are present
ffmpeg ALL Only required for screen recording
xclip Linux, BSD Only required if copy to clipboard is enabled
libnotify/notify-send Linux, BSD Only required if notifications are enabled
terminal-notifier macOS Only required if notifications are enabled

In short, on most systems, you'll need to install curl, maim and jq. If you plan on using any of the "advanced" features, refer to the table above.

Additional notes

On *BSDs (including macOS), you'll need GNU/make (gmake) to install this script.

Installation

From source (recommended)

  1. git clone https://owo.codes/whats-this/owo.sh.git owo.sh
  2. cd owo.sh
  3. git checkout REV where REV is a release. Current latest is v1.0.0
  4. sudo make install. If you want to avoid use of sudo, you can install script to the home of the current using by doing make install PREFIX=$HOME/.local/

Usage

See owo --help

FAQ

Screen recording on macOS?
No.

Symbol Lookup Error on Ubuntu 17.xx
Build from source or upgrade. maim/issues/120.

Wayland support?
No. To elaborate, Wayland quite literally does not support screenshots. It is simply too "secure" to allow such things. Please use Xorg instead.

Contributing

  1. git clone https://owo.codes/whats-this/owo.sh.git owo.sh
  2. Make changes
  3. git add -A && git commit -m 'short message describing your changes'
  4. Create a MR on our repo

License

The contents of this repository are licensed under the GPL version 3. A copy of the GPL can be found in LICENSE or on FSF's web page.

Also see owo --version