diff --git a/README.md b/README.md index 5a8bee5..b7c4152 100644 --- a/README.md +++ b/README.md @@ -70,18 +70,87 @@ Enjoy upcoming **[macOS BigSur](https://www.apple.com/macos/big-sur-preview/)** Cursor Theme for `Windows` and `Linux` with _HiDPi Support_ 🎉. + +
+ Table of Contents (click to expand) + +- [Apple Cursor](#apple-cursor) + - [Cursor Sizes](#cursor-sizes) + - [Colors](#colors) + - [Quick Install For Linux](#quick-install) + - [Manual Install](#manual-install) + - [Linux Install](#linux/x11) + - [Windows Install](#windows) + - [Cursors Preview](#preview) +- [Dependencies](#dependencies) + - [Runtime Dependencies](#runtime-dependencies) + - [Build Dependencies](#build-dependencies) +- [Build From Scrach](#build-from-scratch) + - [⚡ Auto Build (using GitHub Actions)](#⚡-auto-build-using-gitHub-actions) + - [Manual Build](#manual-build) + - [Install Build Theme](#install-build-theme) +- [Bugs](#bugs) +- [Getting Help](#getting-help) +- [Contributing](#contributing) +- [Support ✨](#support) + +
+ +#### Cursor Sizes + +24 +28 +32 +40 +48 +56 +64 +72 +80 +88 +96 + +#### Colors + +![#13A3F5](https://placehold.it/15/13A3F5/000000?text=+) +![#4DCB2C](https://placehold.it/15/4DCB2C/000000?text=+) +![#FED103](https://placehold.it/15/FED103/000000?text=+) +![#FE9D0C](https://placehold.it/15/FE9D0C/000000?text=+) +![#F2493C](https://placehold.it/15/F2493C/000000?text=+) +![#B75DCC](https://placehold.it/15/B75DCC/000000?text=+) +![#000000](https://placehold.it/15/000/000000?text=+) +![#fffff](https://placehold.it/15/fff/000000?text=+) + #### Quick install ##### via curl ```bash -bash <(curl -s "https://raw.githubusercontent.com/ful1e5/apple_cursor/easy-install-patch/scripts/install.sh") +bash <(curl -s "https://raw.githubusercontent.com/ful1e5/apple_cursor/master/scripts/install.sh") ``` ##### via wget ```bash -bash <(wget -qO- "https://raw.githubusercontent.com/ful1e5/apple_cursor/easy-install-patch/scripts/install.sh") +bash <(wget -qO- "https://raw.githubusercontent.com/ful1e5/apple_cursor/master/scripts/install.sh") +``` + +### Manual Install + +#### Linux/X11 + + + + +```bash +# Unpack +mkdir macOSBigSur && tar -xvf macOSBigSur.tar -C macOSBigSur +# For local users +mv macOSBigSur ~/.icons/ +# For all users +sudo mv macOSBigSur /usr/share/icons/ ``` #### Windows @@ -92,19 +161,6 @@ bash <(wget -qO- "https://raw.githubusercontent.com/ful1e5/apple_cursor/easy-ins 4. Open _Control Panel > Personalisation and Appearance > Change mouse pointers_, and select **MacOSBigSur Cursors**. 5. Click '**Apply**'. -#### Cursor Sizes: 24, 28, 32, 40, 48, 56, 64, 72, 80, 88, 96 - -#### Colors: - -- ![#000000](https://placehold.it/15/000/000000?text=+) `#000000` -- ![#fffff](https://placehold.it/15/fff/000000?text=+) `#fffff` -- ![#13A3F5](https://placehold.it/15/13A3F5/000000?text=+) `#13A3F5` -- ![#4DCB2C](https://placehold.it/15/4DCB2C/000000?text=+) `#4DCB2C` -- ![#FED103](https://placehold.it/15/FED103/000000?text=+) `#FED103` -- ![#FE9D0C](https://placehold.it/15/FE9D0C/000000?text=+) `#FE9D0C` -- ![#F2493C](https://placehold.it/15/F2493C/000000?text=+) `#F2493C` -- ![#B75DCC](https://placehold.it/15/B75DCC/000000?text=+) `#B75DCC` - #### Preview: > Detailed Cursors Informations inside [src/svgs/README.md](https://github.com/ful1e5/apple_cursor/blob/master/src/svg/README.md) @@ -114,7 +170,7 @@ bash <(wget -qO- "https://raw.githubusercontent.com/ful1e5/apple_cursor/easy-ins


- macOS Big Sur + macOSBigSur Cursors 🍎

@@ -154,31 +210,7 @@ bash <(wget -qO- "https://raw.githubusercontent.com/ful1e5/apple_cursor/easy-ins - python (<=3.6) - pip3 - - -# Install - -## Basic Installation - -Download latest `stable` & `development` from [here](https://github.com/ful1e5/apple_cursor/releases) according to your **OS**. - -### Linux/X11 - - - - -```bash -# Unpack -mkdir macOSBigSur && tar -xvf macOSBigSur.tar -C macOSBigSur -# For local users -mv macOSBigSur ~/.icons/ -# For all users -sudo mv macOSBigSur /usr/share/icons/ -``` - -## Manual Install +## Build From Scratch > Make sure you have installed all [Build dependencies](#build-dependencies). @@ -186,7 +218,7 @@ sudo mv macOSBigSur /usr/share/icons/ GitHub Actions is automatically runs on every `push`(on **master** and **dev** branches) and `pull request`(on **master** branch), You found theme resources in `artifact` section of **build**.GitHub **Actions** available inside [.github/workflows](https://github.com/ful1e5/apple_cursor/tree/master/.github/workflows) directory. -### Build +### Manual Build ```bash # This command setup python virtual environment && install all packages @@ -197,12 +229,12 @@ yarn compile && yarn unpack After build `bitmaps` and `packages` are generated at project root directory. -### Install Build Cursor - -#### Linux +### Install Build Theme All builded cursor packages are available inside `packages` directory. +#### Linux + ```bash cd ./packages # Unpack .tar archive @@ -235,9 +267,9 @@ You can create a **issue**, I will help you. 🙂 -# Contributions and Suggestions +# Contributing -Check [CONTRIBUTING.md](https://github.com/ful1e5/apple_cursor/blob/master/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`. +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`. diff --git a/src/svg/README.md b/src/svg/README.md index 1899fbd..40dee25 100644 --- a/src/svg/README.md +++ b/src/svg/README.md @@ -2,50 +2,50 @@ ## Symbolic Cursors -| Preview | Source | Symbolic links | -| :------------------------------------------------: | :---------------------: | :-------------------------------------------------------------: | -| | all_scroll.svg | `None` | -| | bottom_left_corner.svg | `fd_double_arrow.svg` `top_right_corner.svg` | -| | bottom_right_corner.svg | `bd_double_arrow.svg` `top_left_corner.svg` | -| | bottom_tee.svg | `None` | -| | center_ptr.svg | `None` | -| | circle.svg | `crossed_circle.svg` `dnd_no_drop.svg` | -| | context_menu.svg | `None` | -| | copy.svg | `dnd_copy.svg` | -| | cross.svg | `tcross.svg` | -| | crosshair.svg | `None` | -| | dotbox.svg | `None` | -| | hand1.svg | `None` | -| | hand2.svg | `None` | -| | left_ptr.svg | `None` | -| | left_side.svg | `right_side.svg` | -| | left_tee.svg | `None` | -| | link.svg | `dnd_link.svg` | -| | ll_angle.svg | `None` | -| | lr_angle.svg | `None` | -| | move.svg | `dnd_move.svg` `dnd_none.svg` `grabbing.svg` `pointer_move.svg` | -| | pencil.svg | `None` | -| | plus.svg | `None` | -| | question_arrow.svg | `dnd_ask.svg` | -| | right_ptr.svg | `None` | -| | right_tee.svg | `None` | -| | sb_down_arrow.svg | `None` | -| | sb_h_double_arrow.svg | `None` | -| | sb_left_arrow.svg | `None` | -| | sb_right_arrow.svg | `None` | -| | sb_up_arrow.svg | `None` | -| | sb_v_double_arrow.svg | `None` | -| | top_side.svg | `bottom_side.svg` | -| | top_tee.svg | `None` | -| | ul_angle.svg | `None` | -| | ur_angle.svg | `None` | -| | vertical_text.svg | `None` | -| | wait.svg | `left_ptr_watch.svg` | -| | wayland_cursor.svg | `None` | -| | x_cursor.svg | `None` | -| | xterm.svg | `None` | -| | zoom_in.svg | `None` | -| | zoom_out.svg | `None` | +| Preview | Source | Symbolic links | Windows Cursor name | +| :------------------------------------------------: | :---------------------: | :-------------------------------------------------------------: | :------------------------------------: | +| | all_scroll.svg | `None` | `move.cur` | +| | bottom_left_corner.svg | `fd_double_arrow.svg` `top_right_corner.svg` | `diagonal-resize-2.cur` | +| | bottom_right_corner.svg | `bd_double_arrow.svg` `top_left_corner.svg` | `diagonal-resize-1.cur` | +| | bottom_tee.svg | `None` | | +| | center_ptr.svg | `None` | | +| | circle.svg | `crossed_circle.svg` `dnd_no_drop.svg` | `unavailable.cur` | +| | context_menu.svg | `None` | | +| | copy.svg | `dnd_copy.svg` | | +| | cross.svg | `tcross.svg` | | +| | crosshair.svg | `None` | `precision-select.cur` | +| | dotbox.svg | `None` | | +| | hand1.svg | `None` | | +| | hand2.svg | `None` | `link-select.cur` | +| | left_ptr.svg | `None` | `normal-select.cur` | +| | left_side.svg | `right_side.svg` | `horizontal-resize.cur` | +| | left_tee.svg | `None` | | +| | link.svg | `dnd_link.svg` | | +| | ll_angle.svg | `None` | | +| | lr_angle.svg | `None` | | +| | move.svg | `dnd_move.svg` `dnd_none.svg` `grabbing.svg` `pointer_move.svg` | | +| | pencil.svg | `None` | `handwriting.cur` | +| | plus.svg | `None` | | +| | question_arrow.svg | `dnd_ask.svg` | `help-select.cur` | +| | right_ptr.svg | `None` | | +| | right_tee.svg | `None` | | +| | sb_down_arrow.svg | `None` | | +| | sb_h_double_arrow.svg | `None` | | +| | sb_left_arrow.svg | `None` | | +| | sb_right_arrow.svg | `None` | | +| | sb_up_arrow.svg | `None` | `alt-select.cur` | +| | sb_v_double_arrow.svg | `None` | | +| | top_side.svg | `bottom_side.svg` | `vertical-resize.cur` | +| | top_tee.svg | `None` | | +| | ul_angle.svg | `None` | | +| | ur_angle.svg | `None` | | +| | vertical_text.svg | `None` | | +| | wait.svg | `left_ptr_watch.svg` | `working-in-background.ani` `busy.ani` | +| | wayland_cursor.svg | `None` | | +| | x_cursor.svg | `None` | `pirate.cur` | +| | xterm.svg | `None` | `text-select.cur` | +| | zoom_in.svg | `None` | | +| | zoom_out.svg | `None` | | ## Figma File