From cd60c3ea3d1d0ae26f03c3431351198ae1ad51e7 Mon Sep 17 00:00:00 2001 From: ful1e5 <24286590+ful1e5@users.noreply.github.com> Date: Sun, 13 Jun 2021 15:28:24 +0530 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9A=20docs=20init?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- PLING.bbcode | 41 +++++++ README.md | 307 ++++++++++++++++++++++++++++++++++++++++++++++++++- 2 files changed, 346 insertions(+), 2 deletions(-) create mode 100644 PLING.bbcode diff --git a/PLING.bbcode b/PLING.bbcode new file mode 100644 index 0000000..31ce485 --- /dev/null +++ b/PLING.bbcode @@ -0,0 +1,41 @@ +[b]BreezeX [/b] Cursor Theme with [b]HiDPi[/b] Display support. This Cursor is built with [b][url=https://github.com/ful1e5/clickgen]clickgen[/url][/b] and render with the [b][url=https://github.com/puppeteer/puppeteer/]puppeteer[/url][/b]. +[i]Available Sizes[/i] [b]22, 24, 28, 32, 40, 48, 56, 64, 72, 80, 88, 96 + +[/b][i]Get latest build[/i] @[b][url=https://github.com/ful1e5/BreezeX_Cursor/actions]GitHub Actions[/url][/b] +[i]Release Notification[/i] at [b][url=https://twitter.com/ful1e5]Twitter[/url][/b](@ful1e5) +For [i]Customizing Size[/i] check [b][url=https://github.com/ful1e5/BreezeX_Cursor#manual-build]README.md[/url][/b] + +[b]Linux/X11 installation[/b] +Get the latest stable Linux release from the [b][url=TODO]Pling[/url][/b]. Unpack [b].tar.gz[/b] file and follow these [b]commands[/b]. + +[b]Install[/b] +[b]For all user:[/b] +[code]sudo mv BreezeX-* /usr/share/icons[/code] +[b]For local user:[/b] +[code]mv BreezeX-* ~/.icons[/code] + +[b]Uninstall[/b] +[b]From all user:[/b] +[code]sudo rm -r /usr/share/icons/BreezeX-*[/code] +[b]From local user:[/b] +[code]rm -r ~/.icons/BreezeX-*[/code] + +[b]Window installation[/b] +[list=1] + [*]unzip [b].zip[/b] file[/*] + [*]Open [b]unziped directory[/b] in Explorer, and [b]right-click[/b] on [b]install.inf[/b].[/*] + [*]Click 'Install' from the context menu, and authorise the modifications to your system.[/*] + [*]Open [i]Control Panel > Personalisation and Appearance > Change mouse pointers[/i], and select [b]BreezeX Cursors[/b].[/*] + [*]Click '[b]Apply[/b]'.[/*] +[/list] + +[b]How I help the Creator?[/b] +[list=2] + [*]Give a [b]Star[/b] or [b]Follow[/b] on [b][url=https://github.com/ful1e5/BreezeX_Cursor]GitHub[/url][/b] (issues & PullRequest are welcome).[/*] + [*]By giving a [b]Pling[/b] or [b][url=https://www.paypal.me/kaizkhatri]Donation[/url][/b].[/*] + [*][b]Download[/b] from[url=https://www.pling.com/p/1408466/] Pling.com[/url] Product page that helps to [b]increases[/b] my [b]monthly payout[/b].[/*] + [*][b][url=https://www.pling.com/support]Become Supporter of Pling.com[/url][/b], So we become [b]Full-Time [/b]Libre & FOSS content creator [b];)[/b][/*] +[/list] + +[b]License & Terms[/b] +'[b]BreezeX[/b]' Cursor Theme is available under the terms of the [b]GPL-3.0[/b] license. diff --git a/README.md b/README.md index 3d94372..39c38f2 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,306 @@ -# BreezeX_Cursor +

+ BreezeX +

-extended KDE cursor πŸ’™ +

+ extended KDE cursor πŸ’™ +

+ + +

+ + + GitHub Action Build + + + + CodeFactor + + + +
+ + npm type definitions + + + + Puppeteer version + + + + Clickgen + + + +
+ + BreezeX Cursor release (latest by date including pre-releases) + + + + License + + + + + +
+ + License + + + + License + + + + License + + + +
+ + Made By Kaiz + +

+ +--- + + + +# BreezeX Cursor + +Extended KDE Cursor theme, Highly inspired on **KDE Breeze** for `Windows` and `Linux` with _HiDPi Support_ πŸŽ‰. + +#### Cursor Sizes + +22 +24 +28 +32 +40 +48 +56 +64 +72 +80 +88 +96 + +#### Colors + +![#4C4C4C](https://imgur.com/oHJxr47.png) +![#FFFFFF](https://imgur.com/0Wexs1k.png) + +#### Quick install + + + + +

+ + + +

+ +#### Preview: + +> Check Figma file [here](https://www.figma.com/file/Uo4LeHvFUPDgoqLjnFc1LB/BreezeX?node-id=0%3A1) + + + +

+ +
+ Dark BreezeX Cursors πŸ–€ +

+ +

+ +
+ Light BreezeX Cursors 🀍 +

+ +### Manual Install + +#### Linux/X11 + +```bash +# extract `BreezeX.tar.gz` +tar -xvf BreezeX.tar.gz + +# For local users +mv BreezeX-* ~/.icons/ + +# For all users +sudo mv BreezeX-* /usr/share/icons/ +``` + +#### Windows + +1. unzip `.zip` file +2. Open unziped directory in Explorer, and **right click** on `install.inf`. +3. Click 'Install' from the context menu, and authorize the modifications to your system. +4. Open _Control Panel > Personalization and Appearance > Change mouse pointers_, and select **BreezeX Cursors**. +5. Click '**Apply**'. + + + +# Dependencies + +## External Libraries + +- libxcursor +- libx11 +- libpng (<=1.6) + +#### Install External Libraries + +##### ~macOS~ **[WIP]** + +```bash +brew install --cask xquartz +brew install libpng +``` + +##### Debain/ubuntu + +```bash +sudo apt install libx11-dev libxcursor-dev libpng-dev +``` + +##### ArchLinux/Manjaro + +```bash +sudo pacman -S libx11 libxcursor libpng +``` + +##### Fedora/Fedora Silverblue/CentOS/RHEL + +```bash +sudo dnf install libX11-devel libXcursor-devel libpng-devel +``` + +## Build Dependencies + +- [gcc](https://gcc.gnu.org/install/) +- [make](https://www.gnu.org/software/make/) +- [nodejs](https://nodejs.org/en/) (<=12.x.x) +- [yarn](https://classic.yarnpkg.com/en/docs/install/) +- [python](https://www.python.org/downloads/) (<=3.8) +- [pip3](https://pip.pypa.io/en/stable/installing/) + +### Node Packages + +- [puppeteer](https://www.npmjs.com/package/puppeteer) +- [pngjs](https://www.npmjs.com/package/pngjs) +- [pixelmatch](https://www.npmjs.com/package/pixelmatch) + +### PyPi Packages + +- [clickgen](https://pypi.org/project/clickgen/s) + +## Build Dependencies + +- [gcc](https://gcc.gnu.org/install/) +- [make](https://www.gnu.org/software/make/) +- [nodejs](https://nodejs.org/en/) (<=12.x.x) +- [yarn](https://classic.yarnpkg.com/en/docs/install/) +- [python](https://www.python.org/downloads/) (<=3.8) +- [pip3](https://pip.pypa.io/en/stable/installing/) + +### Node Packages + +- [puppeteer](https://www.npmjs.com/package/puppeteer) +- [pngjs](https://www.npmjs.com/package/pngjs) +- [pixelmatch](https://www.npmjs.com/package/pixelmatch) + +### PyPi Packages + +- [clickgen](https://pypi.org/project/clickgen/s) + +## Build From Scratch + +### ⚑ Auto Build (using GitHub Actions) + +GitHub Actions is automatically runs on every `push`(on **main** and **dev** branches) and `pull request`(on **main** branch), You found theme resources in `artifact` section of **build**.GitHub **Actions** available inside [.github/workflows](https://github.com/ful1e5/BreezeX_Cursor/tree/main/.github/workflows) directory. + +### Manual Build + +```bash +make +``` + +#### Build `XCursor` theme + +```bash +make unix +``` + +#### Customize `XCursor` size + +```bash +make unix X_SIZES=22 # Only built '22px' pixel-size. +make unix X_SIZES=22 24 32 # Multiple sizes are provided with ' '(Space) +``` + +#### Install `XCursor` theme + +```bash +make install # install as user + # OR +sudo make install # install as root +``` + +#### Build `Windows` theme + +```bash +make windows +``` + +#### Customize `Windows Cursor` size + +```bash +make windows WIN_SIZE=96 # Supports only one pixel-size +``` + +> For installation follow [these](#windows) steps. + + + +# Bugs + +Bugs πŸ› should be reported [here](https://github.com/ful1e5/BreezeX_Cursor/issues) on the Github issues page. + + + +# Getting Help + +You can create a **issue**, I will help you. πŸ™‚ + + + +# Contributing + +Check [CONTRIBUTING.md](CONTRIBUTING.md), any suggestions for features and contributions to the continuing code masterelopment can be made via the issue tracker or code contributions via a `Fork` & `Pull requests`. + + + +## Support + +Give a **β˜…** or Follow on [GitHub](https://github.com/ful1e5),That's work as **Steroid πŸ’‰** for me. πŸ˜‰ + +> For extra support + + + Buy Me A Coffee + + + + +

+ ( `ω´ )ۢ▬ι═══════ﺀ +

+

+ I'm Using Katana +