https://github.com/pupil-labs/pupil-icon-font
Icon font for Pupil software
https://github.com/pupil-labs/pupil-icon-font
Last synced: about 2 months ago
JSON representation
Icon font for Pupil software
- Host: GitHub
- URL: https://github.com/pupil-labs/pupil-icon-font
- Owner: pupil-labs
- License: lgpl-3.0
- Created: 2017-08-18T04:45:09.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2021-09-22T23:37:36.000Z (over 3 years ago)
- Last Synced: 2025-01-16T00:17:53.777Z (3 months ago)
- Language: JavaScript
- Homepage: https://pupil-labs.github.io/pupil-icon-font/
- Size: 217 KB
- Stars: 1
- Watchers: 7
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# pupil-icon-font
Icon font for Pupil software
Using [fontello](https://github.com/fontello/) toolchains to locally optimize and convert individual SVGs to TTF font
Preview the icon font and mappings by opening the index.html in your browser, or see it [online here](https://pupil-labs.github.io/pupil-icon-font/)
## Installation
Install [node](https://nodejs.org/en/download/) and NPM.
### Install Node Dependencies
```
npm install
```
## Make tasks
### Make all tasks
```
make
```
### Make glyph`.svg` and `.ttf` font
```
make font
```
### Generate `.html` with icon font and glyphs
```
make index
```
### Optimize SVGs
```
make optimize
```
## Project structure
Diagram of repo hierarchy
```
/pupil-icon-font
|-- svgs
`-- individual svgs
|-- font
`-- glyph svg and ttf file
```
## Development
Fork and clone to work locally.
### New SVG icons
Add icons to `./svgs` folder,
Edit `config.yml` to specify your icon names and unicode mapping for each glyph.
Make sure the icon codename is the same as the svg icon file name.
### SVG requirements
- All svg icons must be `1000x1000` px.
- Svg path must be a compound path.
- Black and white, no colors.
- No fills.
Example
```html
```
**Note** - Other tags will be stripped out during the make process.
### SVG Optimization
Run `make optimize`, to optimize images with `SVGO` or on the web - https://jakearchibald.github.io/svgomg/
## License
Font is distributed under LGPL-3.0 licence.
All icons are distributed under their respective licences (Apache License Version 2.0).