Skip to content

Commit 045bdff

Browse files
authored
Merge branch 'main' into homebrew-doc
2 parents 60deed0 + 020f2b5 commit 045bdff

4 files changed

Lines changed: 40 additions & 31 deletions

File tree

.gitignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
1-
.DS_STORE
1+
.DS_STORE
2+
.vscode

.vscode/settings.json

Lines changed: 0 additions & 5 deletions
This file was deleted.

README.md

Lines changed: 36 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Monaspace
22

3-
The Monaspace type system: a monospaced type superfamily with some modern tricks up its sleeves. It is comprised of five variable axis typefaces. Each one has a distinct voice, but they are all metrics-compatible with one another, allowing you to mix and match them for a more expressive typographical palette.
3+
The Monaspace type system is a monospaced type superfamily with some modern tricks up its sleeve. It consists of five variable axis typefaces. Each one has a distinct voice, but they are all metrics-compatible with one another, allowing you to mix and match them for a more expressive typographical palette.
44

55
Letters on a grid is how we see our code. Why not make those letters better?
66

@@ -13,18 +13,18 @@ Letters on a grid is how we see our code. Why not make those letters better?
1313

1414
## Overview
1515

16-
Monaspace is made available as both a variable-axis font and as static builds. You can install them both side-by-side; their family names are distinct. For example:
16+
Monaspace is available as a variable-axis font and a static build. You can install them both side-by-side; their family names are distinct. For example:
1717

1818
- `Monaspace _____`: the static family
1919
- `Monaspace _____ Var` or `VF`: the variable family
2020

21-
The variable fonts have one file per family (Neon, Argon, etc). Modern and convenient!
21+
The variable fonts have one file per family (Neon, Argon, etc.). Modern and convenient!
2222

23-
The static fonts have one file per cut per family. The variable axes have named stops for each of the axes, like `light` or `bold` for weight, `italic` for italics, and `semiwide` and `wide` for width. The combinatoric explosion of all these properties means that the full installation of static fonts involves hundreds of font files. But for situations which don't yet support variable fonts, the static builds give you a wide variety of stops throughout the range of each axis.
23+
The static fonts have one file per cut, per family. The variable axes have named stops for each axis, like `light` or `bold` for weight, `italic` for italics, and `semiwide` or `wide` for width. The combinatorial explosion of all these properties means the complete installation of static fonts involves hundreds of font files. But for situations that don't yet support variable fonts, the static builds give you a wide variety of stops throughout the range of each axis.
2424

2525
## Coding Ligatures
2626

27-
There are eight groups of coding ligatures, separated into stylistic sets. You may be able to selectively enable or disable individual sets:
27+
There are eight groups of coding ligatures, separated into stylistic sets. You may be able to enable or disable individual sets selectively:
2828

2929
* `ss01`: ligatures related to the equals glyph like `!=` and `===`.
3030
* `ss02`: ligatures related to the greater than or less than operators.
@@ -35,20 +35,21 @@ There are eight groups of coding ligatures, separated into stylistic sets. You m
3535
* `ss07`: ligatures related to the asterisk like `***`.
3636
* `ss08`: ligatures related to combinations like `.=` or `.-`.
3737

38-
You must enable discrectionary ligatures first, often using the `dlig` setting. See below for editor-specific instructions.
38+
You must enable discretionary ligatures first, often using the `dlig` setting. See below for editor-specific instructions.
3939

4040
![A visual glossary of code ligatures available in the Monaspace type system](https://github.com/githubnext/monaspace/assets/22723/49b4f802-265d-414c-94c0-ec712e3c0ecc)
4141

4242

4343
## Desktop Installation
4444

4545
### MacOS
46-
You can manually drag the fonts from the `fonts/otf` and `fonts/variable` directory into Font Book.
46+
You can manually drag the fonts from the `fonts/otf` or `fonts/variable` directory into Font Book.
4747

48-
There is also a script which automates the deletion of all Monaspace fonts from `~/Library/Fonts` and then copies over the latest versions. Invoke it from the root of the repo like:
48+
There is also a script that automates the deletion of all Monaspace fonts from `~/Library/Fonts` and then copies over the latest versions. Invoke it from the root of the repo like:
4949

5050
```bash
51-
$ bash ./util/install_macos.sh
51+
$ cd util
52+
$ bash ./install_macos.sh
5253
```
5354

5455
You can also use [homebrew](https://brew.sh/) as an alternative:
@@ -58,48 +59,60 @@ brew tap homebrew/cask-fonts
5859
brew install font-monaspace
5960
```
6061

62+
### Windows
63+
You can manually drag the fonts from the `fonts/otf` or `fonts/variable` directory into `C:\Windows\Fonts`. Alternatively, right-click the fonts you want and click Install.
64+
6165
### Webfonts
6266

63-
All files with a `.woff` or `.woff2` suffix are intended for use on the web. You do not install them with your operating system, but rather add them to your web development project.
67+
All files with a `.woff` or `.woff2` suffix are intended for use on the web. You do not install them with your operating system but add them to your web development project.
6468

65-
As with the desktop fonts, they are made availabe both as variable and static fonts.
69+
As with the desktop fonts, they are available in variable and static versions.
6670

6771
## Editors
6872

6973
### Visual Studio Code
7074

71-
Texture healing and coding ligatures are controlled by the same setting. You can enable either, or both.
75+
Set the font family:
76+
77+
```json
78+
"editor.fontFamily": "'Monaspace Neon', monospace",
79+
```
80+
81+
> [!NOTE]
82+
> Variable fonts are not yet well-supported in VS Code, and it is not yet possible to mix multiple fonts. Stay tuned, we're talking with the VS Code team about it!
83+
84+
The same setting controls texture healing and coding ligatures. You can enable either or both.
7285

7386
If you only want texture healing and basic coding ligatures, add the following line to your `settings.json`:
7487

75-
```
88+
```json
7689
"editor.fontLigatures": true,
7790
```
7891

7992
> [!NOTE]
80-
> This setting is not available from the graphical settings editor, you must create it manually.
93+
> This setting is unavailable from the graphical settings editor; you must create it manually.
8194
82-
If you want more coding ligatures, you must customize that setting to specify all of the sets you want enabled:
95+
If you want more coding ligatures, you must customize that setting to specify all the sets you wish to enable:
8396

84-
```
97+
```json
8598
"editor.fontLigatures": "'calt', 'liga', 'dlig', 'ss01', 'ss02', ... (more stylistic sets) ...",
8699
```
87100
> [!NOTE]
88-
> You must start the setting with `'calt', 'liga', 'dlig'`! The stylistic sets will not have any effect without enabling contextual alternates, ligatures, and discretionary ligatures.
101+
> You must start the setting with `'calt', 'liga', 'dlig'`! The stylistic sets will only have an effect by enabling contextual alternates, ligatures, and discretionary ligatures.
89102
90-
If you want coding ligatures but do _not_ want texture healing, you can elide the `calt` setting:
103+
If you want coding ligatures but do _not_ want texture healing, you can omit the `calt` setting:
91104

92-
```
105+
```json
93106
"editor.fontLigatures": "'liga', 'dlig', 'ss01', 'ss02', ... (more stylistic sets) ...",
94107
```
95108

96109
## Contribution
97110

98-
There's no formal contribution guide yet! If you're interested in contributing to the typefaces, you should read the [Texture Healing](https://github.com/githubnext/monaspace/blob/main/docs/Texture%20Healing.md) guide, as it explains how to produce the neccessary alternate glyphs.
111+
There's no formal contribution guide yet! If you're interested in contributing to the typefaces, you should read the [Texture Healing](https://github.com/githubnext/monaspace/blob/main/docs/Texture%20Healing.md) guide, as it explains how to produce the necessary alternate glyphs.
99112

100113
### Renamer utility
101114

102-
This is a convenience utility which renames moves the built fonts into the respective directories. You will need [Deno](https://deno.land) installed, and invoke it thus:
115+
This convenience utility renames and moves the built fonts into their respective directories. You will need [Deno](https://deno.land) installed, and invoke it thus:
103116

104117
```bash
105118
$ ./util/renamer.ts --src="~/path/to/the/built/fonts"
@@ -111,11 +124,11 @@ SIL OFL. See [LICENSE](https://github.com/githubnext/monaspace/blob/main/LICENSE
111124

112125
## Support
113126

114-
Please file issues on this repo. Monaspace is not a supported product; do not reach out to GitHub support with questions as they do not provide support for GitHub Next explorations.
127+
Please file issues in this repo. Monaspace is not a supported product; do not contact GitHub support with questions, as they do not support GitHub Next explorations.
115128

116129
## Contributors
117130

118-
Monaspace was made with the goal of improving all code, for all developers. [GitHub Next](https://githubnext.com) set out on this journey in 2022, and we were fortunate to find a type foundry that shares our passion for improving software in [Lettermatic](https://lettermatic.com/). The result is a marriage of form and function that opens the door to new developer experiences, and that would not have been possible without the domain expertise and skill of the lettermatic team, and the time they invested to work with GitHub Next on figuring out how typography ought to work for code.
131+
Monaspace was made to improve all code for all developers. [GitHub Next](https://githubnext.com) set out on this journey in 2022, and we were fortunate to find a type foundry that shares our passion for improving software in [Lettermatic](https://lettermatic.com/). The result is a marriage of form and function that opens the door to new developer experiences, and that would not have been possible without the domain expertise and skill of the Lettermatic team and the time they invested in working with GitHub Next on figuring out how typography ought to work for code.
119132

120133

121134
#### Lettermatic

util/install_macos.sh

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
rm -rf ~/Library/Fonts/Monaspace*
55

66
# copy all fonts from ./otf to ~/Library/Fonts
7-
cp ./fonts/otf/* ~/Library/Fonts
7+
cp ../fonts/otf/* ~/Library/Fonts
88

99
# copy variable fonts from ./variable to ~/Library/Fonts
10-
cp ./fonts/variable/* ~/Library/Fonts
10+
cp ../fonts/variable/* ~/Library/Fonts

0 commit comments

Comments
 (0)