Skip to content

Commit c123983

Browse files
authored
Update README
1 parent 21ebe32 commit c123983

File tree

1 file changed

+12
-4
lines changed

1 file changed

+12
-4
lines changed

README.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Pinhead is a library of free vector icons. There are other projects like this, b
1717
1. Cartography first
1818
2. 100% public domain
1919

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

2222
## Usage
2323

@@ -46,7 +46,7 @@ Pinhead has no dependencies and is basically just a directory of SVG files. A fe
4646

4747
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.
4848

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

5151
## Where the icons are from
5252

@@ -100,9 +100,12 @@ If the following sections seem too technical or intimidating, feel free to just
100100
* Multiple icons for different perspectives of the same thing can be okay if they're all iconic.
101101
* Orientation
102102
* 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).
103105
* Hand tools should be pointed to the right.
104106
* 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).
106109

107110
#### SVGs
108111

@@ -116,7 +119,12 @@ If the following sections seem too technical or intimidating, feel free to just
116119
* Filenames should be literal and descriptive at the risk of being verbose.
117120
* E.g. prefer <img src="https://pinhead.ink/v1/giraffe.svg" height="15px" width="15px"/> `giraffe` to `zoo` and <img src="https://pinhead.ink/v1/greek_cross.svg" height="15px" width="15px"/> `greek_cross` to `medicine`.
118121
* 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.
120128

121129
### AI/ML policy
122130

0 commit comments

Comments
 (0)