You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+50-13Lines changed: 50 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,21 +1,58 @@
1
-
# Phinger cursors
1
+
# Phinger Cursors
2
2
3
-
Say hello to your new cursor theme. Phinger cursors is most likely the most over engineered cursor theme out there.
3
+
Say hello to your new cursor theme. Phinger Cursors is most likely the most over engineered cursor theme out there.
4
4
5
5

6
6
7
7
## How to install
8
8
9
-
If you are on Arch linux, you can install the AUR package [phinger-cursors](https://aur.archlinux.org/packages/phinger-cursors).
9
+
### Arch Linux
10
10
11
-
Other distros currently don't yet have phinger-cursors in their repositories. So please install manually, as described below.
11
+
I'm maintaining [phinger-cursors](https://aur.archlinux.org/packages/phinger-cursors) in the Arch User Repository. You can install it with your favorite AUR helper:
12
+
13
+
```sh
14
+
paru -S phinger-cursors
15
+
```
16
+
17
+
> [!NOTE]
18
+
> Please let me know if you want to maintain this package in the official Arch Linux repositories, so that I can update the instructions here.
19
+
20
+
### Ubuntu
21
+
22
+
Install the `phinnger-cursor-theme` from the Ubuntu repositories (thanks to @eeickmeyer):
23
+
24
+
```sh
25
+
apt-get update
26
+
apt-get install phinger-cursor-theme
27
+
```
28
+
29
+
### NixOS
30
+
31
+
You can install the `phinger-cursors` package (thanks to @moni-dz) from the NixOS repositories by adding it to your `configuration.nix`:
32
+
33
+
```nix
34
+
environment.systemPackages = with pkgs; [
35
+
phinger-cursors
36
+
];
37
+
```
38
+
39
+
Or use it in your home-manager configuration:
40
+
41
+
```nix
42
+
home.pointerCursor = {
43
+
name = "phinger-cursors-light";
44
+
package = pkgs.phinger-cursors;
45
+
size = 32;
46
+
gtk.enable = true;
47
+
};
48
+
```
12
49
13
50
### Manually
14
51
15
-
For a manual installation, download and extract the [latest release](https://github.com/phisch/phinger-cursors/releases/latest/download/phinger-cursors-variants.tar.bz2) into the `~/.icons` directory.
52
+
For a manual installation, download and extract the [latest release](https://github.com/phisch/phinger-cursors/releases/latest/download/phinger-cursors-variants.tar.bz2) into the `~/.local/share/icons` directory.
16
53
17
54
```sh
18
-
wget -cO- https://github.com/phisch/phinger-cursors/releases/latest/download/phinger-cursors-variants.tar.bz2 | tar xfj - -C ~/.icons
55
+
wget -cO- https://github.com/phisch/phinger-cursors/releases/latest/download/phinger-cursors-variants.tar.bz2 | tar xfj - -C ~/.local/share/icons
19
56
```
20
57
21
58
This installs the cursor theme for your current user. To install for all users, extract into `/usr/share/icons` instead.
@@ -26,7 +63,7 @@ You might have a settings application installed that can do this for you like [G
26
63
27
64
### Manually
28
65
29
-
Enable your prefered variant (`phinger-cursors`or `phinger-cursors-light`) inside `~/.icons/default/index.theme`:
66
+
Enable your prefered variant `phinger-cursors-dark`, `phinger-cursors-light`or their left-handed counterparts `phinger-cursors-dark-left` or `phinger-cursors-light-left` inside `~/.icons/default/index.theme`:
30
67
31
68
```ini
32
69
[Icon Theme]
@@ -64,7 +101,7 @@ Xcursor.size: CURSOR_SIZE
64
101
65
102
## How it's made
66
103
67
-
Phinger-cursors are designed in a [Figma](https://www.figma.com) document. Check out the [multi-page Figma document](https://www.figma.com/file/zU99op23bu3Cg438YkhZy8/phinger-cursors) used by this repository.
104
+
Phinger Cursors are designed in a [Figma](https://www.figma.com) document. Check out the [multi-page Figma document](https://www.figma.com/file/zU99op23bu3Cg438YkhZy8/phinger-cursors) used by this repository.
68
105
69
106
You can find an up to date copy of that document in this repositories root directory at [phinger-cursors.fig](phinger-cursors.fig).
70
107
@@ -80,8 +117,8 @@ Each part is designed on a base grid of 24 and 32:
80
117
81
118
which means will be pixel perfect for any reasonable size:
If possible, parts are designed very modular, which lets you create multiple different icons from one part. A good example is the hand part that comes with multiple variations for each single phinger:
@@ -96,14 +133,14 @@ Each cursor contains information about which cursor and variant it belongs to, w
96
133
97
134
### Build process
98
135
99
-
Phinger cursors are built using my [Cursor Theme Builder](https://github.com/phisch/cursor-theme-builder). It provides a JSON schema to describe a cursor theme, an exporter, that can create such a JSON file and assets from a Figma file, and a builder, which makes fully functioning X11 cursor theme variants from that. It also allows to transform cursors into left-handed versions, comes with an animation system and more.
136
+
Phinger Cursors are built using my [Cursor Theme Builder](https://github.com/phisch/cursor-theme-builder). It provides a JSON schema to describe a cursor theme, an exporter, that can create such a JSON file and assets from a Figma file, and a builder, which makes fully functioning X11 cursor theme variants from that. It also allows to transform cursors into left-handed versions, comes with an animation system and more.
100
137
101
138
This repository contains [workflows](.github/workflows) to extract a cursor-theme.json and assets, and drafts a release with built cursor theme variants.
102
139
103
140
## License & Credits
104
141
All assets, including the Figma document are licensed under the [CC-BY-SA-4.0 License](LICENSE).
105
142
106
-
Although designed from scratch, phinger cursors drew inspiration from [capitaine-cursors](https://github.com/keeferrourke/capitaine-cursors), which is based on the KDE Breeze cursors. So this is a special thanks to them, and all other amazing cursor themes out there!
143
+
Although designed from scratch, Phinger Cursors drew inspiration from [capitaine-cursors](https://github.com/keeferrourke/capitaine-cursors), which is based on the KDE Breeze cursors. So this is a special thanks to them, and all other amazing cursor themes out there!
107
144
108
145
## Contribute
109
146
@@ -115,4 +152,4 @@ I can't let people contribute to the Figma document directly, but I will listen
I am actively working on phinger-cursors and other cool projects on the [Desktop Makers Discord](https://discord.gg/RqKTeA4uxW). It aims to be a community for communities of Linux desktop related projects. If you are looking to collaborate with or want to contribute to great projects, this might be the right place for you.
155
+
I am actively working on Phinger Cursors and other cool projects on the [Desktop Makers Discord](https://discord.gg/RqKTeA4uxW). It aims to be a community for communities of Linux desktop related projects. If you are looking to collaborate with or want to contribute to great projects, this might be the right place for you.
0 commit comments