Skip to content

Commit bcc8c5d

Browse files
ahatemahatem
committed
Initial commit: Add project files and GitHub Action
0 parents  commit bcc8c5d

7 files changed

Lines changed: 383 additions & 0 deletions

File tree

‎.github/workflows/build-font.yml‎

Lines changed: 93 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
name: Build and Release Font
2+
3+
on:
4+
push:
5+
branches: ["main"]
6+
paths:
7+
- "private-build-plans.toml"
8+
- ".github/workflows/**"
9+
workflow_dispatch:
10+
11+
jobs:
12+
build:
13+
runs-on: ubuntu-latest
14+
permissions:
15+
contents: write
16+
17+
steps:
18+
# 1. Checkout your repository to get the config file
19+
- name: Checkout repository
20+
uses: actions/checkout@v4
21+
22+
# 2. Checkout the official Iosevka repository to get the build tools
23+
- name: Checkout Iosevka source
24+
uses: actions/checkout@v4
25+
with:
26+
repository: be5invis/Iosevka
27+
path: iosevka-src
28+
depth: 1
29+
30+
# 3. Install system dependencies required by Iosevka
31+
- name: Install system dependencies
32+
run: |
33+
sudo apt-get update
34+
sudo apt-get install -y ttfautohint python3
35+
36+
# 4. Set up Node.js, which is required by the Iosevka build scripts
37+
- name: Set up Node.js
38+
uses: actions/setup-node@v4
39+
with:
40+
node-version: "20"
41+
42+
# 5. Copy your custom build plan into the Iosevka source directory
43+
- name: Copy custom build plan
44+
run: cp private-build-plans.toml iosevka-src/
45+
46+
# 6. Navigate into the Iosevka directory, install dependencies, and build the font
47+
- name: Install dependencies and build font
48+
run: |
49+
cd iosevka-src
50+
npm install
51+
npm run build -- ttf::IoskeleyMono
52+
53+
# 7. Verify build output exists (More specific check)
54+
- name: Verify build output
55+
run: |
56+
if [ ! -d "iosevka-src/dist/IoskeleyMono/TTF" ] || [ ! -d "iosevka-src/dist/IoskeleyMono/TTF-Unhinted" ]; then
57+
echo "Build output directories (TTF and/or TTF-Unhinted) not found!"
58+
exit 1
59+
fi
60+
echo "Hinted and Unhinted build directories verified."
61+
62+
# 8. Create separate ZIP archives for hinted and unhinted fonts (MODIFIED STEP)
63+
- name: Package font files into separate archives
64+
run: |
65+
# Package the Hinted fonts
66+
cd iosevka-src/dist/IoskeleyMono/TTF
67+
zip -r ../../../../IoskeleyMono-Hinted.zip .
68+
# Package the Unhinted fonts
69+
cd ../TTF-Unhinted
70+
zip -r ../../../../IoskeleyMono-Unhinted.zip .
71+
72+
# 9. Set the release version number
73+
- name: Set Release Version
74+
id: vars
75+
run: echo "tag=$(date +'%Y.%m.%d')-${{ github.run_number }}" >> $GITHUB_OUTPUT
76+
77+
# 10. Create a new GitHub Release and upload both ZIP files (MODIFIED STEP)
78+
- name: Create Release and Upload Assets
79+
uses: softprops/action-gh-release@v1
80+
with:
81+
tag_name: ${{ steps.vars.outputs.tag }}
82+
name: "Release ${{ steps.vars.outputs.tag }}"
83+
body: |
84+
Automated build triggered by commit ${{ github.sha }}.
85+
86+
Two versions are attached:
87+
- `IoskeleyMono-Hinted.zip`: Fonts with hinting for better rendering on lower-resolution screens.
88+
- `IoskeleyMono-Unhinted.zip`: Raw, unhinted fonts preferred by some users, especially on high-DPI displays.
89+
files: |
90+
IoskeleyMono-Hinted.zip
91+
IoskeleyMono-Unhinted.zip
92+
env:
93+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

‎.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.vscode

‎LICENSE‎

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
Copyright (c) 2025, Ahmed Hatem (https://github.com/ahatem)
2+
3+
This Font Software is licensed under the SIL Open Font License, Version 1.1.
4+
This license is copied below, and is also available with a FAQ at:
5+
http://scripts.sil.org/OFL
6+
7+
---
8+
9+
## SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
10+
11+
PREAMBLE
12+
The goals of the Open Font License (OFL) are to stimulate worldwide
13+
development of collaborative font projects, to support the font creation
14+
efforts of academic and linguistic communities, and to provide a free and
15+
open framework in which fonts may be shared and improved in partnership
16+
with others.
17+
18+
The OFL allows the licensed fonts to be used, studied, modified and
19+
redistributed freely as long as they are not sold by themselves. The
20+
fonts, including any derivative works, can be bundled, embedded,
21+
redistributed and/or sold with any software provided that any reserved
22+
names are not used by derivative works. The fonts and derivatives,
23+
however, cannot be released under any other type of license. The
24+
requirement for fonts to remain under this license does not apply
25+
to any document created using the fonts or their derivatives.
26+
27+
DEFINITIONS
28+
"Font Software" refers to the set of files released by the Copyright
29+
Holder(s) under this license and clearly marked as such. This may
30+
include source files, build scripts and documentation.
31+
32+
"Reserved Font Name" refers to any names specified as such after the
33+
copyright statement(s).
34+
35+
"Original Version" refers to the collection of Font Software components as
36+
distributed by the Copyright Holder(s).
37+
38+
"Modified Version" refers to any derivative made by adding to, deleting,
39+
or substituting -- in part or in whole -- any of the components of the
40+
Original Version, by changing formats or by porting the Font Software to a
41+
new environment.
42+
43+
"Author" refers to any designer, engineer, programmer, technical
44+
writer or other person who contributed to the Font Software.
45+
46+
PERMISSION & CONDITIONS
47+
Permission is hereby granted, free of charge, to any person obtaining
48+
a copy of the Font Software, to use, study, copy, merge, embed, modify,
49+
redistribute, and sell modified and unmodified copies of the Font
50+
Software, subject to the following conditions:
51+
52+
1. Neither the Font Software nor any of its individual components,
53+
in Original or Modified Versions, may be sold by itself.
54+
55+
1. Original or Modified Versions of the Font Software may be bundled,
56+
redistributed and/or sold with any software, provided that each copy
57+
contains the above copyright notice and this license. These can be
58+
included either as stand-alone text files, human-readable headers or
59+
in the appropriate machine-readable metadata fields within text or
60+
binary files as long as those fields can be easily viewed by the user.
61+
62+
1. No Modified Version of the Font Software may use the Reserved Font
63+
Name(s) unless explicit written permission is granted by the corresponding
64+
Copyright Holder. This restriction only applies to the primary font name as
65+
presented to the users.
66+
67+
1. The name(s) of the Copyright Holder(s) or the Author(s) of the Font
68+
Software shall not be used to promote, endorse or advertise any
69+
Modified Version, except to acknowledge the contribution(s) of the
70+
Copyright Holder(s) and the Author(s) or with their explicit written
71+
permission.
72+
73+
1. The Font Software, modified or unmodified, in part or in whole,
74+
must be distributed entirely under this license, and must not be
75+
distributed under any other license. The requirement for fonts to
76+
remain under this license does not apply to any document created
77+
using the Font Software.
78+
79+
TERMINATION
80+
This license becomes null and void if any of the above conditions are
81+
not met.
82+
83+
DISCLAIMER
84+
THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
85+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
86+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
87+
OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
88+
COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
89+
INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
90+
DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
91+
FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
92+
OTHER DEALINGS IN THE FONT SOFTWARE.

‎README.md‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# IoskeleyMono
2+
3+
The goal of this project is to configure the [Iosevka](https://github.com/be5invis/Iosevka) typeface to mimic the look and feel of **Berkeley Mono** as closely as possible.
4+
5+
It uses Iosevka's extensive build options to select character variants that replicate the distinct aesthetic of Berkeley Mono, creating a free, open-source alternative for fans of that particular style.
6+
7+
The name is a simple mashup: **Iosevka** + **Berkeley** = **Ioskeley**.
8+
9+
This repository uses GitHub Actions to automatically build the font files whenever the configuration is updated.
10+
11+
---
12+
13+
## Installation
14+
15+
The easiest way to get the font is to download it directly from the **Releases** page.
16+
17+
1. [Click here to go to the Releases Page](https://github.com/ahatem/IoskeleyMono/releases)
18+
2. Find the latest release and download the `IoskeleyMono-Build.zip` file.
19+
3. Unzip the file and install the fonts on your system.
20+
21+
---
22+
23+
## Preview
24+
25+
### Ioskeley Mono
26+
27+
![Ioskeley Mono Preview](./assets/IoskeleyMono.png)
28+
29+
### Berkeley Mono
30+
31+
![Berkeley Mono Preview](./assets/BerkeleyMono.png)
32+
33+
### Configuration Choices
34+
35+
To achieve the Berkeley Mono aesthetic, the following key variants were selected from Iosevka's available glyphs:
36+
37+
- **Numbers:** Dotted zero (`0`) and open-contour `6` and `9`.
38+
- **Key Characters:** A classic double-storey `a` and a modern single-storey `g`.
39+
- **Punctuation:** Sharp, square dots for a crisp, technical feel.
40+
- **Underscore:** Set to `high` for better visibility.
41+
- **Ligatures:** Standard programming ligatures are enabled.
42+
43+
For a complete list of all choices made to match Berkeley Mono, see the [`private-build-plans.toml`](./private-build-plans.toml) file.
44+
45+
---
46+
47+
### License & Credits
48+
49+
**Credits**: Ioskeley Mono is a custom configuration of the Iosevka typeface. All credit for the original design and build system goes to Belleve Invis and the Iosevka contributors.
50+
51+
Because this is a derivative of Iosevka, it is licensed under the same **SIL Open Font License 1.1**. See the `LICENSE` file for full details.

‎assets/BerkeleyMono.png‎

176 KB
Loading

‎assets/IoskeleyMono.png‎

182 KB
Loading

‎private-build-plans.toml‎

Lines changed: 146 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,146 @@
1+
[buildPlans.IoskeleyMono]
2+
family = "IoskeleyMono"
3+
spacing = "normal"
4+
serifs = "sans"
5+
noCvSs = true
6+
exportGlyphNames = false
7+
8+
[buildPlans.IoskeleyMono.variants.design]
9+
one = "no-base"
10+
two = "straight-neck-serifless"
11+
three = "flat-top-serifless"
12+
four = "semi-open-serifless"
13+
five = "upright-flat-serifless"
14+
six = "open-contour"
15+
seven = "straight-serifless"
16+
eight = "crossing-asymmetric"
17+
nine = "open-contour"
18+
zero = "dotted"
19+
capital-a = "straight-serifless"
20+
capital-b = "standard-serifless"
21+
capital-c = "bilateral-inward-serifed"
22+
capital-d = "standard-serifless"
23+
capital-e = "serifless"
24+
capital-f = "serifless"
25+
capital-g = "toothless-corner-inward-serifed-hooked"
26+
capital-h = "serifless"
27+
capital-i = "serifed"
28+
capital-j = "serifless"
29+
capital-k = "symmetric-touching-serifless"
30+
capital-l = "serifless"
31+
capital-m = "hanging-serifless"
32+
capital-n = "standard-serifless"
33+
capital-p = "closed-serifless"
34+
capital-q = "crossing"
35+
capital-r = "standing-serifless"
36+
capital-s = "serifless"
37+
capital-t = "serifless"
38+
capital-u = "toothless-rounded-serifless"
39+
capital-v = "straight-serifless"
40+
capital-w = "straight-flat-top-serifless"
41+
capital-x = "straight-serifless"
42+
capital-y = "straight-serifless"
43+
capital-z = "straight-serifless"
44+
a = "double-storey-serifless"
45+
b = "toothed-serifless"
46+
c = "bilateral-inward-serifed"
47+
d = "toothed-serifless"
48+
e = "flat-crossbar"
49+
f = "flat-hook-serifless-crossbar-at-x-height"
50+
g = "single-storey-serifless"
51+
h = "straight-serifless"
52+
i = "serifed"
53+
j = "flat-hook-serifed"
54+
k = "symmetric-touching-serifless"
55+
l = "serifed"
56+
m = "serifless"
57+
n = "straight-serifless"
58+
p = "eared-serifless"
59+
q = "straight-serifless"
60+
r = "hookless-serifless"
61+
s = "serifless"
62+
t = "flat-hook-short-neck2"
63+
u = "toothed-serifless"
64+
v = "straight-serifless"
65+
w = "straight-flat-top-serifless"
66+
x = "straight-serifless"
67+
y = "straight-serifless"
68+
z = "straight-serifless"
69+
lower-theta = "oval"
70+
tittle = "square"
71+
punctuation-dot = "square"
72+
braille-dot = "square"
73+
tilde = "low"
74+
asterisk = "penta-mid"
75+
underscore = "high"
76+
caret = "medium"
77+
ascii-grave = "straight"
78+
ascii-single-quote = "straight"
79+
paren = "flat-arc"
80+
brace = "curly"
81+
guillemet = "straight"
82+
number-sign = "slanted"
83+
ampersand = "closed"
84+
at = "fourfold"
85+
dollar = "through"
86+
cent = "through-cap"
87+
percent = "rings-segmented-slash"
88+
bar = "natural-slope"
89+
question = "corner"
90+
pilcrow = "high"
91+
micro-sign = "toothed-serifless"
92+
decorative-angle-brackets = "middle"
93+
lig-ltgteq = "slanted"
94+
lig-neq = "slightly-slanted"
95+
lig-equal-chain = "without-notch"
96+
lig-hyphen-chain = "without-notch"
97+
lig-plus-chain = "without-notch"
98+
lig-double-arrow-bar = "without-notch"
99+
lig-single-arrow-bar = "without-notch"
100+
101+
[buildPlans.IoskeleyMono.weights.Regular]
102+
shape = 400
103+
menu = 400
104+
css = 400
105+
106+
[buildPlans.IoskeleyMono.weights.Bold]
107+
shape = 700
108+
menu = 700
109+
css = 700
110+
111+
[buildPlans.IoskeleyMono.weights.Light]
112+
shape = 300
113+
menu = 300
114+
css = 300
115+
116+
[buildPlans.IoskeleyMono.weights.Medium]
117+
shape = 500
118+
menu = 500
119+
css = 500
120+
121+
[buildPlans.IoskeleyMono.weights.SemiBold]
122+
shape = 600
123+
menu = 600
124+
css = 600
125+
126+
[buildPlans.IoskeleyMono.weights.ExtraBold]
127+
shape = 800
128+
menu = 800
129+
css = 800
130+
131+
[buildPlans.IoskeleyMono.widths.Normal]
132+
shape = 600
133+
menu = 5
134+
css = "normal"
135+
136+
[buildPlans.IoskeleyMono.slopes.Upright]
137+
angle = 0
138+
shape = "upright"
139+
menu = "upright"
140+
css = "normal"
141+
142+
[buildPlans.IoskeleyMono.slopes.Italic]
143+
angle = 9.4
144+
shape = "italic"
145+
menu = "italic"
146+
css = "italic"

0 commit comments

Comments
 (0)