mirrors/apple_cursor
1
0
Fork 0
mirror of https://github.com/ful1e5/apple_cursor.git synced 2024-09-19 23:38:50 -04:00
Code Issues Projects Releases Packages Wiki Activity

Merge pull request #19 from ful1e5/Documentation

Browse source 
Windows Cursors Info & Docs Improvements
This commit is contained in:
Kaiz 2020-08-11 17:54:49 +05:30 committed by GitHub
commit 63838a2448
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 123 additions and 91 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

126
README.md
View file

@ -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 Content -->
<details>
<summary><strong>Table of Contents</strong> (click to expand)</summary>
- [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)
</details>
#### Cursor Sizes
<kbd>24</kbd>
<kbd>28</kbd>
<kbd>32</kbd>
<kbd>40</kbd>
<kbd>48</kbd>
<kbd>56</kbd>
<kbd>64</kbd>
<kbd>72</kbd>
<kbd>80</kbd>
<kbd>88</kbd>
<kbd>96</kbd>
#### 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
<!-- Install Video -->
<!-- <p align="center">
<video src="https://i.imgur.com/zIF1JkH.mp4" width="75%" autoplay loop preload></video>
</p> -->
```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
<p align="center">
<img title="macOS Big Sur" src="https://imgur.com/BA0gkrO.png">
</br>
<sub>macOS Big Sur</sub>
<sub>macOSBigSur Cursors 🍎</sub>
</p>
<!-- Build Dependencies -->
@ -154,31 +210,7 @@ bash <(wget -qO- "https://raw.githubusercontent.com/ful1e5/apple_cursor/easy-ins
- python (<=3.6)
- pip3
<!-- Install -->
# Install
## Basic Installation
Download latest `stable` & `development` from [here](https://github.com/ful1e5/apple_cursor/releases) according to your **OS**.
### Linux/X11
<!-- Install Video -->
<!-- <p align="center">
<video src="https://i.imgur.com/zIF1JkH.mp4" width="75%" autoplay loop preload></video>
</p> -->
```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 Suggestion -->
# 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`.
<!-- Support -->

88
src/svg/README.md
View file

@ -2,50 +2,50 @@
## Symbolic Cursors
| Preview | Source | Symbolic links |
| :------------------------------------------------: | :---------------------: | :-------------------------------------------------------------: |
| <img src="./all_scroll.svg" width="20%"/> | all_scroll.svg | `None` |
| <img src="./bottom_left_corner.svg" width="20%"/> | bottom_left_corner.svg | `fd_double_arrow.svg` `top_right_corner.svg` |
| <img src="./bottom_right_corner.svg" width="20%"/> | bottom_right_corner.svg | `bd_double_arrow.svg` `top_left_corner.svg` |
| <img src="./bottom_tee.svg" width="20%"/> | bottom_tee.svg | `None` |
| <img src="./center_ptr.svg" width="20%"/> | center_ptr.svg | `None` |
| <img src="./circle.svg" width="20%"/> | circle.svg | `crossed_circle.svg` `dnd_no_drop.svg` |
| <img src="./context_menu.svg" width="20%"/> | context_menu.svg | `None` |
| <img src="./copy.svg" width="20%"/> | copy.svg | `dnd_copy.svg` |
| <img src="./cross.svg" width="20%"/> | cross.svg | `tcross.svg` |
| <img src="./crosshair.svg" width="20%"/> | crosshair.svg | `None` |
| <img src="./dotbox.svg" width="20%"/> | dotbox.svg | `None` |
| <img src="./hand1.svg" width="20%"/> | hand1.svg | `None` |
| <img src="./hand2.svg" width="20%"/> | hand2.svg | `None` |
| <img src="./left_ptr.svg" width="20%"/> | left_ptr.svg | `None` |
| <img src="./left_side.svg" width="20%"/> | left_side.svg | `right_side.svg` |
| <img src="./left_tee.svg" width="20%"/> | left_tee.svg | `None` |
| <img src="./link.svg" width="20%"/> | link.svg | `dnd_link.svg` |
| <img src="./ll_angle.svg" width="20%"/> | ll_angle.svg | `None` |
| <img src="./lr_angle.svg" width="20%"/> | lr_angle.svg | `None` |
| <img src="./move.svg" width="20%"/> | move.svg | `dnd_move.svg` `dnd_none.svg` `grabbing.svg` `pointer_move.svg` |
| <img src="./pencil.svg" width="20%"/> | pencil.svg | `None` |
| <img src="./plus.svg" width="20%"/> | plus.svg | `None` |
| <img src="./question_arrow.svg" width="20%"/> | question_arrow.svg | `dnd_ask.svg` |
| <img src="./right_ptr.svg" width="20%"/> | right_ptr.svg | `None` |
| <img src="./right_tee.svg" width="20%"/> | right_tee.svg | `None` |
| <img src="./sb_down_arrow.svg" width="20%"/> | sb_down_arrow.svg | `None` |
| <img src="./sb_h_double_arrow.svg" width="20%"/> | sb_h_double_arrow.svg | `None` |
| <img src="./sb_left_arrow.svg" width="20%"/> | sb_left_arrow.svg | `None` |
| <img src="./sb_right_arrow.svg" width="20%"/> | sb_right_arrow.svg | `None` |
| <img src="./sb_up_arrow.svg" width="20%"/> | sb_up_arrow.svg | `None` |
| <img src="./sb_v_double_arrow.svg" width="20%"/> | sb_v_double_arrow.svg | `None` |
| <img src="./top_side.svg" width="20%"/> | top_side.svg | `bottom_side.svg` |
| <img src="./top_tee.svg" width="20%"/> | top_tee.svg | `None` |
| <img src="./ul_angle.svg" width="20%"/> | ul_angle.svg | `None` |
| <img src="./ur_angle.svg" width="20%"/> | ur_angle.svg | `None` |
| <img src="./vertical_text.svg" width="20%"/> | vertical_text.svg | `None` |
| <img src="./wait.svg" width="20%"/> | wait.svg | `left_ptr_watch.svg` |
| <img src="./wayland_cursor.svg" width="20%"/> | wayland_cursor.svg | `None` |
| <img src="x_cursor.svg" width="20%"/> | x_cursor.svg | `None` |
| <img src="./xterm.svg" width="20%"/> | xterm.svg | `None` |
| <img src="./zoom_in.svg" width="20%"/> | zoom_in.svg | `None` |
| <img src="./zoom_out.svg" width="20%"/> | zoom_out.svg | `None` |
| Preview | Source | Symbolic links | Windows Cursor name |
| :------------------------------------------------: | :---------------------: | :-------------------------------------------------------------: | :------------------------------------: |
| <img src="./all_scroll.svg" width="20%"/> | all_scroll.svg | `None` | `move.cur` |
| <img src="./bottom_left_corner.svg" width="20%"/> | bottom_left_corner.svg | `fd_double_arrow.svg` `top_right_corner.svg` | `diagonal-resize-2.cur` |
| <img src="./bottom_right_corner.svg" width="20%"/> | bottom_right_corner.svg | `bd_double_arrow.svg` `top_left_corner.svg` | `diagonal-resize-1.cur` |
| <img src="./bottom_tee.svg" width="20%"/> | bottom_tee.svg | `None` | |
| <img src="./center_ptr.svg" width="20%"/> | center_ptr.svg | `None` | |
| <img src="./circle.svg" width="20%"/> | circle.svg | `crossed_circle.svg` `dnd_no_drop.svg` | `unavailable.cur` |
| <img src="./context_menu.svg" width="20%"/> | context_menu.svg | `None` | |
| <img src="./copy.svg" width="20%"/> | copy.svg | `dnd_copy.svg` | |
| <img src="./cross.svg" width="20%"/> | cross.svg | `tcross.svg` | |
| <img src="./crosshair.svg" width="20%"/> | crosshair.svg | `None` | `precision-select.cur` |
| <img src="./dotbox.svg" width="20%"/> | dotbox.svg | `None` | |
| <img src="./hand1.svg" width="20%"/> | hand1.svg | `None` | |
| <img src="./hand2.svg" width="20%"/> | hand2.svg | `None` | `link-select.cur` |
| <img src="./left_ptr.svg" width="20%"/> | left_ptr.svg | `None` | `normal-select.cur` |
| <img src="./left_side.svg" width="20%"/> | left_side.svg | `right_side.svg` | `horizontal-resize.cur` |
| <img src="./left_tee.svg" width="20%"/> | left_tee.svg | `None` | |
| <img src="./link.svg" width="20%"/> | link.svg | `dnd_link.svg` | |
| <img src="./ll_angle.svg" width="20%"/> | ll_angle.svg | `None` | |
| <img src="./lr_angle.svg" width="20%"/> | lr_angle.svg | `None` | |
| <img src="./move.svg" width="20%"/> | move.svg | `dnd_move.svg` `dnd_none.svg` `grabbing.svg` `pointer_move.svg` | |
| <img src="./pencil.svg" width="20%"/> | pencil.svg | `None` | `handwriting.cur` |
| <img src="./plus.svg" width="20%"/> | plus.svg | `None` | |
| <img src="./question_arrow.svg" width="20%"/> | question_arrow.svg | `dnd_ask.svg` | `help-select.cur` |
| <img src="./right_ptr.svg" width="20%"/> | right_ptr.svg | `None` | |
| <img src="./right_tee.svg" width="20%"/> | right_tee.svg | `None` | |
| <img src="./sb_down_arrow.svg" width="20%"/> | sb_down_arrow.svg | `None` | |
| <img src="./sb_h_double_arrow.svg" width="20%"/> | sb_h_double_arrow.svg | `None` | |
| <img src="./sb_left_arrow.svg" width="20%"/> | sb_left_arrow.svg | `None` | |
| <img src="./sb_right_arrow.svg" width="20%"/> | sb_right_arrow.svg | `None` | |
| <img src="./sb_up_arrow.svg" width="20%"/> | sb_up_arrow.svg | `None` | `alt-select.cur` |
| <img src="./sb_v_double_arrow.svg" width="20%"/> | sb_v_double_arrow.svg | `None` | |
| <img src="./top_side.svg" width="20%"/> | top_side.svg | `bottom_side.svg` | `vertical-resize.cur` |
| <img src="./top_tee.svg" width="20%"/> | top_tee.svg | `None` | |
| <img src="./ul_angle.svg" width="20%"/> | ul_angle.svg | `None` | |
| <img src="./ur_angle.svg" width="20%"/> | ur_angle.svg | `None` | |
| <img src="./vertical_text.svg" width="20%"/> | vertical_text.svg | `None` | |
| <img src="./wait.svg" width="20%"/> | wait.svg | `left_ptr_watch.svg` | `working-in-background.ani` `busy.ani` |
| <img src="./wayland_cursor.svg" width="20%"/> | wayland_cursor.svg | `None` | |
| <img src="x_cursor.svg" width="20%"/> | x_cursor.svg | `None` | `pirate.cur` |
| <img src="./xterm.svg" width="20%"/> | xterm.svg | `None` | `text-select.cur` |
| <img src="./zoom_in.svg" width="20%"/> | zoom_in.svg | `None` | |
| <img src="./zoom_out.svg" width="20%"/> | zoom_out.svg | `None` | |
## Figma File