Skip to content

Commit 3704e6b

Browse files
committed
docs: Add README
1 parent 0bf8715 commit 3704e6b

File tree

1 file changed

+54
-0
lines changed

1 file changed

+54
-0
lines changed

README.md

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,55 @@
11
# Eyecons
2+
3+
A 16x16 (vector) icon pack that prioritizes consistency and quality over quantity.
4+
5+
<!-- vim-markdown-toc GFM -->
6+
7+
* [Preview](#preview)
8+
* [Usage](#usage)
9+
* [Building](#building)
10+
11+
<!-- vim-markdown-toc -->
12+
13+
# Preview
14+
15+
Navigate to [my personal website](https://bbfh.me/eyecons.html) to see an up-to-date preview of all icons.
16+
17+
# Usage
18+
19+
Simply download the [latest version](https://github.com/bbfh-dev/eyecons/releases/latest). You **do NOT** need to give attributing when doing fair-use (e.g. using it on your website for buttons, but not creating your own icon repository).
20+
21+
```bash
22+
# File structure:
23+
$ tree -d ./build/latest/
24+
├── raster/
25+
│   ├── black/
26+
│   │   ├── 12x12/
27+
│   │   ├── 16x16/
28+
│   │   ├── 24x24/
29+
│   │   ├── 32x32/
30+
│   │   ├── 48x48/
31+
│   │   └── 64x64/
32+
│   ├── pixelart/
33+
│   │   ├── 16x16/
34+
│   │   ├── 32x32/
35+
│   │   └── 64x64/
36+
│   └── white/
37+
│   ├── 12x12/
38+
│   ├── 16x16/
39+
│   ├── 24x24/
40+
│   ├── 32x32/
41+
│   ├── 48x48/
42+
│   └── 64x64/
43+
└── symbolic/
44+
├── black/
45+
├── web/
46+
└── white/
47+
```
48+
49+
# Building
50+
51+
Building requires the following additional binaries to be installed: `resvg`, `ffmpeg`, `tar` & `zip`
52+
53+
```bash
54+
./build.sh
55+
```

0 commit comments

Comments
 (0)