diff --git a/README.md b/README.md index 1ef9bd2..c65992b 100644 --- a/README.md +++ b/README.md @@ -1,98 +1,49 @@ -

- Hyprpicker logo -

+# hyprpicker -

- Repo Size - Language - License - Wayland -

+A wlroots-compatible Wayland color picker that does not suck. -

A sleek, wlroots-native color picker for Wayland built for Hyprland with a focus on speed, accuracy, and simplicity.

+![hyprpickerShort](https://user-images.githubusercontent.com/43317083/188224867-7d77a3b3-0a66-488c-8019-39b00060ab42.gif) -

- hyprpicker demo -

+# Usage +Launch it. Click. That's it. +## Options -## ✨ Description +See `hyprpicker --help`. -**Hyprpicker** is a **blazing-fast, minimal, and accurate color picker** built for **Wayland compositors** like **Hyprland**. -It lets you instantly grab any color from your screen with pixel-perfect precision. +# Installation -Hyprpicker is designed to *just work* with clipboard copying, format selection, zoom lens, and desktop notifications. +## Arch +`sudo pacman -S hyprpicker` +## Manual (Building) -## 🚀 Usage +Install dependencies: + - cmake + - pkg-config + - pango + - cairo + - wayland + - wayland-protocols + - hyprutils + - xkbcommon -**Run it, click anywhere, get the color.** -By default, the color is printed to stdout. Combine it with options like clipboard copy or notification for a smoother experience. +Building is done via CMake: ```sh -hyprpicker -a -n -b -f rgb +cmake --no-warn-unused-cli -DCMAKE_BUILD_TYPE:STRING=Release -DCMAKE_INSTALL_PREFIX:PATH=/usr -S . -B ./build +cmake --build ./build --config Release --target hyprpicker -j`nproc 2>/dev/null || getconf _NPROCESSORS_CONF` ``` - - -## 🧰 Command-Line Options +Install with: ```sh -Hyprpicker usage: hyprpicker [arg [...]]. - -Arguments: - -a | --autocopy | Automatically copies the output to the clipboard (requires wl-clipboard) - -f | --format=fmt | Specifies the output format (cmyk, hex, rgb, hsl, hsv) - -n | --notify | Sends a desktop notification when a color is picked (requires notify-send and a notification daemon like dunst) - -b | --no-fancy | Disables the "fancy" (aka. colored) outputting - -h | --help | Show this help message - -r | --render-inactive | Render (freeze) inactive displays - -z | --no-zoom | Disable the zoom lens - -q | --quiet | Disable most logs (leaves errors) - -v | --verbose | Enable more logs - -t | --no-fractional | Disable fractional scaling support - -d | --disable-preview | Disable live preview of color - -l | --lowercase-hex | Outputs the hexcode in lowercase - -V | --version | Print version info +cmake --install ./build ``` +# Caveats +"Freezes" your displays when picking the color. -## 📦 Installation - -```sh -sudo pacman -S hyprpicker -``` - - - -## 🔧 Build From Source - -### Dependencies - -- cmake -- pkg-config -- pango -- cairo -- wayland -- wayland-protocols -- hyprutils -- xkbcommon - - - -### Build and install - -```sh -cmake --no-warn-unused-cli -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=/usr -S . -B ./build -cmake --build ./build --config Release --target hyprpicker -j$(nproc) -sudo cmake --install ./build -``` - - - -## 📚 License - -Hyprpicker is licensed under the BSD 3-Clause License — a permissive license that allows nearly unrestricted use, including commercial, as long as proper credit is given.