From 50fea1262edd7e0205ae0f3b4456e783dcfee6e9 Mon Sep 17 00:00:00 2001 From: r3b00thx Date: Fri, 6 Jun 2025 17:33:48 +0300 Subject: [PATCH] chore(readme): update README.md In this commit I updated the readme file to look much nicer and better offering more information regarding HyprPicker and better design overall. --- README.md | 104 +++++++++++++++++++++++++++++++----------- src/notify/Notify.hpp | 1 - 2 files changed, 77 insertions(+), 28 deletions(-) diff --git a/README.md b/README.md index c42834f..f019f2e 100644 --- a/README.md +++ b/README.md @@ -1,48 +1,98 @@ -# hyprpicker +

+ Hyprpicker logo +

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

+ Repo Size + Language + License + Wayland +

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

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

-# Usage +

+ hyprpicker demo +

-Launch it. Click. That's it. -## Options -See `hyprpicker --help`. +## ✨ Description -# Installation +**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. -## Arch +Hyprpicker is designed to *just work* with clipboard copying, format selection, zoom lens, and desktop notifications. -`sudo pacman -S hyprpicker` -## Manual (Building) -Install dependencies: - - cmake - - pkg-config - - pango - - cairo - - wayland - - wayland-protocols - - hyprutils - - xkbcommon +## 🚀 Usage -Building is done via CMake: +**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. ```sh -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` +hyprpicker -a -n -b -fmt rgb ``` -Install with: + + +## 🧰 Command-Line Options ```sh -cmake --install ./build +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 ``` -# 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. diff --git a/src/notify/Notify.hpp b/src/notify/Notify.hpp index 79a7271..1cd09f0 100644 --- a/src/notify/Notify.hpp +++ b/src/notify/Notify.hpp @@ -2,7 +2,6 @@ #include #include -#define NOTIFYBODYSIZE 128 namespace NNotify { void send(std::string hexColor, std::string formattedColor);