Skip to content

Commit 1b9e7f2

Browse files
committed
updated figma file and installation instructions
1 parent eb9180f commit 1b9e7f2

File tree

2 files changed

+50
-13
lines changed

2 files changed

+50
-13
lines changed

README.md

Lines changed: 50 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,58 @@
1-
# Phinger cursors
1+
# Phinger Cursors
22

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.
44

55
![preview](assets/preview.png)
66

77
## How to install
88

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
1010

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+
```
1249

1350
### Manually
1451

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.
1653

1754
```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
1956
```
2057

2158
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
2663

2764
### Manually
2865

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`:
3067

3168
```ini
3269
[Icon Theme]
@@ -64,7 +101,7 @@ Xcursor.size: CURSOR_SIZE
64101

65102
## How it's made
66103

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.
68105

69106
You can find an up to date copy of that document in this repositories root directory at [phinger-cursors.fig](phinger-cursors.fig).
70107

@@ -80,8 +117,8 @@ Each part is designed on a base grid of 24 and 32:
80117

81118
which means will be pixel perfect for any reasonable size:
82119

83-
| 24 | 32 | 48 | 64 | 72 | 96 | 128 |
84-
|:-:|:-:|:-:|:-:|:-:|:-:|:-:|
120+
| 24 | 32 | 48 | 64 | 72 | 96 | 128 |
121+
| :-------------------------: | :-------------------------: | :-------------------------: | :-------------------------: | :-------------------------: | :-------------------------: | :---------------------------: |
85122
| ![24](assets/sprite_24.png) | ![32](assets/sprite_32.png) | ![48](assets/sprite_48.png) | ![64](assets/sprite_64.png) | ![72](assets/sprite_72.png) | ![96](assets/sprite_96.png) | ![128](assets/sprite_128.png) |
86123

87124
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
96133

97134
### Build process
98135

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.
100137

101138
This repository contains [workflows](.github/workflows) to extract a cursor-theme.json and assets, and drafts a release with built cursor theme variants.
102139

103140
## License & Credits
104141
All assets, including the Figma document are licensed under the [CC-BY-SA-4.0 License](LICENSE).
105142

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!
107144

108145
## Contribute
109146

@@ -115,4 +152,4 @@ I can't let people contribute to the Figma document directly, but I will listen
115152

116153
<a href="https://discord.gg/RqKTeA4uxW" title="Desktop Makers Discord"><img align="left" width="72" alt="type=discord" src="https://user-images.githubusercontent.com/1282767/161089772-d7ad28bf-76eb-4951-b0f0-985afd5ea57a.png"></a>
117154

118-
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.

phinger-cursors.fig

-120 KB
Binary file not shown.

0 commit comments

Comments
 (0)