aboutsummarylogtreecommitdiffstats
path: root/README.md
blob: 29ec8254baef67ccb54f89006448a735bf40e663 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
# Iosevka Generate

Iosevka Generate is a tool to generate your own [Iosevka][Iosevka] font for you.

[Iosevka][Iosevka] is a fantastic 'for code from code' font, for which all credit goes to [Belleve Invis][Invis] - this repo is merely a helper script to leverage others' hard work.

NB: Iosevka itself now has a TOML spec for font building, which can now be used as the input to `iosevka-generate`. The remaining added value is:
  - handle acquiring & installing repo and dependencies automatically
  - similarly auto-storing/re-caching the generated font
  - patch with [nerd font][NerdFont] (currently in INI format only, cf. #8)

## Usage

In your `$XDG_CONFIG_HOME` (or `$HOME/.config`) create `iosevka/my-font.toml` in Iosevka's 'private-build-plans' TOML format, or `iosevka/config.ini`, in INI format such as:
```ini
[options]
    name = myosevka
    serifs = sans
    ligset = haskell
    nerdfont = fontawesome powerline material octicons

[common]
    l = hooky

[upright]
    q = straight
    zero = slashed

[italic]
    i = hooky
    at = fourfold

[oblique]
    g = opendoublestory
    numbersign = slanted
```

Details of the (growing) options available can be found in the [font's readme][Iosevka].

## Installation

If you clone this repo, you can just create a symbolic link to the contained script somewhere on your `$PATH`:
```sh
ln -s $CLONED_DIR/iosevka-generate /usr/local/bin/iosevka-generate
```

On Arch, use the `PKGBUILD` script in this repo or from the [AUR][aur/iosevka-generate].

On macOS, use the contained brew formula:
```sh
brew install https://raw.githubusercontent.com/OJFord/iosevka-generate/blob/master/iosevka-generate.rb

# Or, from my `brew tap OJFord/formulae`:
brew install OJFord/formulae/iosevka-generate
```

## Licence

The helper tool in this repository is licensed according to the [LICENCE.md](/LICENCE.md) contained within.

This tool retrieves and makes use of the Iosevka font and supporting build tooling, which are copyright of [Belle Invis][Invis] and licensed as described in [that project's repository][Iosevka].

Nerd Font is (optionally) used for patching additional glyphs, and is copyright of [Ryan L. McIntyre][McIntyre] and licensed as described in [that project's repository][NerdFont].


[aur/iosevka-generate]: https://aur.archlinux.org/packages/iosevka-generate
[Invis]: https://github.com/be5invis
[Iosevka]: https://github.com/be5invis/iosevka
[NerdFont]: https://github.com/ryanoasis/nerd-fonts