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
+12-4Lines changed: 12 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,7 +17,7 @@ Pinhead is a library of free vector icons. There are other projects like this, b
17
17
1. Cartography first
18
18
2. 100% public domain
19
19
20
-
Map icons need to be really small to support high visual density, so all of Pinhead icon's are intended to be legible at **15x15 pixels** minimum. This is much smaller than most other icon sets you'll find, but you can scale them up and they'll still look great. And since they're licensed **CC0**, you can use them anywhere for anything without restrictions.
20
+
Map icons need to be really small to support high visual density, so all of Pinhead icon's are intended to be legible at **15x15 pixels** minimum. This is much smaller than most other icon sets you'll find, but you can scale them up and they'll still look great. And since they're licensed **CC0**, you can use them anywhere for free without restrictions.
21
21
22
22
## Usage
23
23
@@ -46,7 +46,7 @@ Pinhead has no dependencies and is basically just a directory of SVG files. A fe
46
46
47
47
Pinhead uses a flavor of semantic versioning, with major releases (v2.0.0) corresponding to breaking changes, minor releases (v2.1.0) corresponding to backwards-compatible changes, and patch releases (v2.1.1) corresponding to fixes.
48
48
49
-
When it comes to icons, renaming or deleting an icon, or making any visual modification, is a breaking change. Perhaps counterintuitively, adding a new icon is also considered a breaking change. The goal is clear version integrity, where each major version number refers to a complete set of icons with no differences between minor versions. This avoids common gotchas, like developers depending on a package like `^1.0.0` and potentially seeing different lists of icons in development vs. production in the case where v1.1.0 adds an icon.
49
+
When it comes to icons: renaming or deleting an icon, or making any visual modification, is a breaking change. Perhaps counterintuitively, adding a new icon is also considered a breaking change. The goal is clear version integrity, where each major version number refers to a complete set of icons with no differences between minor versions. In effect, this means you can think of Pinhead v1 and Pinhead v2 as two static, independent icon sets. This avoids common gotchas, like developers depending on a package like `^1.0.0` and potentially seeing different lists of icons in development vs. production in the case where v1.1.0 adds an icon.
50
50
51
51
## Where the icons are from
52
52
@@ -100,9 +100,12 @@ If the following sections seem too technical or intimidating, feel free to just
100
100
* Multiple icons for different perspectives of the same thing can be okay if they're all iconic.
101
101
* Orientation
102
102
* People, animals, vehicles, etc. depicted in profile should be facing to the right.
103
+
* Except when moving backwards (e.g. boats on slipways).
104
+
* Except when standing in opposition to movement (e.g. the "stop arm" checkpoint officers).
103
105
* Hand tools should be pointed to the right.
104
106
* Icons with major and minor elements positioned side-by-side should have the major element on the left and minor element on the right.
105
-
* Multiple icons for different orientations generally isn't useful. Users can manually rotate or flip icons as needed.
107
+
* Multiple icons for different orientations generally isn't useful. Users can manually rotate or flip icons if desired.
108
+
* Except when a different orientation gives the icon a different meaning (e.g. arrows).
106
109
107
110
#### SVGs
108
111
@@ -116,7 +119,12 @@ If the following sections seem too technical or intimidating, feel free to just
116
119
* Filenames should be literal and descriptive at the risk of being verbose.
117
120
* E.g. prefer <imgsrc="https://pinhead.ink/v1/giraffe.svg"height="15px"width="15px"/> `giraffe` to `zoo` and <imgsrc="https://pinhead.ink/v1/greek_cross.svg"height="15px"width="15px"/> `greek_cross` to `medicine`.
118
121
* Two files should have similar names if the components of their icons are similar.
119
-
* The subdirectory of an icon is not important.
122
+
* Two files cannot share a name, even if they are in different subdirectories.
123
+
124
+
#### Subdirectories
125
+
* The subdirectory of an icon is used only for developer-side convenience and has no effect on distributed icons.
126
+
* Files are broadly organized by design, not by content.
127
+
* Some subdirectories contain README.md files which give more detailed information.
0 commit comments