Skip to content

Commit 37d6849

Browse files
SableRafSableRaf
committed
Added JetBrains Mono README
1 parent 209b6a9 commit 37d6849

1 file changed

Lines changed: 137 additions & 0 deletions

File tree

‎src/styles/fonts/JetBrains Mono/README.md‎

Lines changed: 137 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,137 @@
1+
*This is a copy of the official JetBrains Mono README found at https://github.com/JetBrains/JetBrainsMono/blob/master/README.md*
2+
3+
# JetBrains Mono: a typeface made for developers
4+
![Alt text](https://raw.githubusercontent.com/JetBrains/JetBrainsMono/master/images/main-img@2x.png)
5+
6+
JetBrains Mono is available as a standalone download, and is also bundled in all JetBrains IDEs. Discover more font features & design on its [web page](https://jetbrains.com/mono/).
7+
8+
Default version of JetBrains Mono comes with OpenType features and ligatures (which can always be toggled on & off in the settings). If your IDE doesn’t support OpenType, use a special version of the font — [JetBrains Mono NL](https://github.com/JetBrains/JetBrainsMono/tree/master/fonts/ttf), which doesn’t include any ligatures.
9+
10+
# **Installation**
11+
12+
### **JetBrains IDEs**
13+
14+
The most recent version of JetBrains Mono ships with your JetBrains IDE starting with v2019.3.
15+
16+
Select JetBrains Mono in the IDE settings: go to `Preferences/Settings` → `Editor` → `Font`, and then select JetBrains Mono from the **Font** dropdown.
17+
18+
### Brew (macOS only)
19+
20+
1. Tap the font cask to make the Jetbrains Mono font available:
21+
22+
```console
23+
brew tap homebrew/cask-fonts
24+
```
25+
2. Install it using the `font-jetbrains-mono` cask:
26+
27+
```console
28+
brew install --cask font-jetbrains-mono
29+
```
30+
31+
### Manual installation
32+
33+
_On Mac/Windows_:
34+
35+
1. [Download font](https://github.com/JetBrains/JetBrainsMono/releases/latest).
36+
2. Unzip the archive and install the font:
37+
- _Mac_. Select all font files in the folder and double-click them. Click the **Install Font** button.
38+
- _Windows_. Select all font files in the folder, right-click any of them, then pick **Install** from the menu.
39+
40+
> **Note** If you have previously installed JetBrains Mono, please uninstall all previous versions to exclude conflicts and errors in rendering.
41+
42+
_On Linux_:
43+
44+
Open a terminal and run the following:
45+
46+
```bash
47+
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/JetBrains/JetBrainsMono/master/install_manual.sh)"
48+
```
49+
50+
Once JetBrains Mono is installed in your OS, you are ready to configure the editor.
51+
52+
53+
### **Visual Studio Code**
54+
55+
1. From the **File** menu (**Code** on Mac) go to `Preferences` → `Settings`, or use keyboard shortcut <kbd>Ctrl</kbd>+<kbd>,</kbd> (<kbd>Cmd</kbd>+<kbd>,</kbd> on Mac).
56+
2. In the **Editor: Font Family** input box type `JetBrains Mono`, replacing any content.
57+
3. To enable ligatures, go to **Editor: Font Ligatures**, click **Edit in settings.json**, and copy this line `"editor.fontLigatures": true` into json file.
58+
59+
### **More ways to install**
60+
- [Chocolatey](https://github.com/JetBrains/JetBrainsMono/wiki/Other-ways-to-install#through-chocolatey-windows-only)
61+
- [ChromeOS terminal](https://github.com/JetBrains/JetBrainsMono/wiki/Other-ways-to-install#chromeos-terminal)
62+
63+
## Font Styles
64+
There are 8 font styles available in JetBrains Mono, from Thin to ExtraBold, each coming with its own _italic_ version.
65+
66+
![Alt text](https://raw.githubusercontent.com/JetBrains/JetBrainsMono/master/images/font-styles@2x.png)
67+
68+
## Font Features
69+
70+
### Increased x-height
71+
While characters remain standard in width, the height of the lowercase is maximized. This approach keeps code lines to the length that developers expect, and it helps improve rendering in small size, since each symbol occupies more pixels.
72+
73+
![Alt text](https://raw.githubusercontent.com/JetBrains/JetBrainsMono/master/images/ff-increased-height@2x.png)
74+
75+
### Distinctiveness of symbols
76+
77+
![Alt text](https://raw.githubusercontent.com/JetBrains/JetBrainsMono/master/images/ff-distinctiveness-of-symbols@2x.gif)
78+
79+
## Ligatures for Code
80+
A ligature is a character consisting of two or more joined symbols. Traditionally, it was introduced as a space-saving technique in printed texts. In code, this technique is adopted to show operators and is used mainly for two purposes:
81+
1. To **reduce noise** by merging symbols and removing details so the eyes are processing less:
82+
83+
![Alt text](https://raw.githubusercontent.com/JetBrains/JetBrainsMono/master/images/ligatures-1@2x.gif)
84+
85+
2. To balance whitespace more efficiently by shifting the glyphs in certain cases:
86+
87+
![Alt text](https://raw.githubusercontent.com/JetBrains/JetBrainsMono/master/images/ligatures-2@2x.gif)
88+
89+
> **Note** if your IDE doesn’t support OpenType features and ligatures, use [JetBrains Mono NL](https://github.com/JetBrains/JetBrainsMono/tree/master/fonts/ttf) instead.
90+
91+
## OpenType features
92+
Starting from v2.304, JetBrains Mono has added support for alternate characters.
93+
_Stylistic Sets_ `ss01-20` usually change a group of characters. _Character Variant_ `cv01-99` usually changes only one character.
94+
Here are the [instructions for enabling these features.](https://github.com/JetBrains/JetBrainsMono/wiki/OpenType-features)
95+
96+
![Alt text](https://raw.githubusercontent.com/JetBrains/JetBrainsMono/master/images/stylistic-sets@2x.png)
97+
![Alt text](https://raw.githubusercontent.com/JetBrains/JetBrainsMono/master/images/character-variants@2x.png)
98+
99+
## Basic Character Set
100+
101+
![Alt text](https://raw.githubusercontent.com/JetBrains/JetBrainsMono/master/images/character-set@2x.png)
102+
You can find full JetBrains Mono character set on our [wiki page](https://github.com/JetBrains/JetBrainsMono/wiki/List-of-supported-symbols).
103+
104+
## Building from source files
105+
106+
> **Note** To build from source, you'd need Python 3.9.5 or higher (install instructions for Python [available here](https://wiki.python.org/moin/BeginnersGuide/Download)).
107+
108+
The source files can be found in the *"Source"* folder. To open them you will need Glyphs app.\
109+
To build the `.ttf`, `.otf`, `woff2` & variable `.ttf` you will need to:
110+
- Install **gftools** `pip install gftools`
111+
- Install **fonttools[woff]** `pip install fonttools[woff]`
112+
- Navigate to **JetBrainsMono** folder in Terminal app.
113+
- Type `gftools builder sources/config.yaml` in Terminal and run it.
114+
- Type `python scripts/generate_variable_webfonts.py` in Terminal and run it to generate variable `woff2` files.
115+
- After the scripts are complete, the files can be found in *fonts* folder.
116+
117+
## License
118+
119+
JetBrains Mono typeface is available under the [OFL-1.1 License](https://github.com/JetBrains/JetBrainsMono/blob/master/OFL.txt) and can be used free of charge, for both commercial and non-commercial purposes. You do not need to give credit to JetBrains, although we will appreciate it very much if you do.
120+
121+
The source code is available under [Apache 2.0 License](https://www.apache.org/licenses/LICENSE-2.0)
122+
123+
## Credits
124+
125+
**Type designer**\
126+
Philipp Nurullin
127+
128+
**Team lead**\
129+
Konstantin Bulenkov
130+
131+
**Thanks to**\
132+
Nikita Prokopov\
133+
Eugene Auduchinok\
134+
Tatiana Tulupenko\
135+
Dmitrij Batrak\
136+
IntelliJ Platform UX Team\
137+
Web Team

0 commit comments

Comments
 (0)