1
0
Fork 0
mirror of synced 2024-05-20 12:33:29 +12:00
FiraCode/README.md

218 lines
8.5 KiB
Markdown
Raw Normal View History

2014-11-12 08:47:04 +13:00
## Fira Code: monospaced font with programming ligatures
2019-07-17 02:42:49 +12:00
<img src="./showcases/fira_code_logo.svg">
2015-07-31 00:27:45 +12:00
2014-11-12 08:47:04 +13:00
### Problem
2016-04-02 01:45:12 +13:00
Programmers use a lot of symbols, often encoded with several characters. For the human brain, sequences like `->`, `<=` or `:=` are single logical tokens, even if they take two or three characters on the screen. Your eye spends a non-zero amount of energy to scan, parse and join multiple characters into a single logical one. Ideally, all programming languages should be designed with full-fledged Unicode symbols for operators, but thats not the case yet.
2014-11-12 08:47:04 +13:00
### Solution
#### [Download v.2](https://github.com/tonsky/FiraCode/releases/download/2/FiraCode_2.zip) · [How to install](https://github.com/tonsky/FiraCode/wiki) · [Troubleshooting](https://github.com/tonsky/FiraCode/wiki#troubleshooting) · [News & updates](https://twitter.com/FiraCode)
2015-12-21 20:29:09 +13:00
2018-09-19 07:39:18 +12:00
<a href="https://patreon.com/tonsky" target="_blank"><img src="./fira_code_patreon.png"></a>
2016-03-24 14:24:28 +13:00
Fira Code is an extension of the Fira Mono font containing a set of ligatures for common programming multi-character combinations. This is just a font rendering feature: underlying code remains ASCII-compatible. This helps to read and understand code faster. For some frequent sequences like `..` or `//`, ligatures allow us to correct spacing.
2014-11-12 08:47:04 +13:00
2017-09-29 01:13:33 +13:00
<img src="./showcases/all_ligatures.png">
2014-11-12 08:47:04 +13:00
2016-08-30 23:34:40 +12:00
### Code examples
Ruby:
2017-09-29 01:13:33 +13:00
<img src="./showcases/ruby.png">
2016-08-30 23:34:40 +12:00
JavaScript:
2017-09-29 01:13:33 +13:00
<img src="./showcases/javascript.png">
PHP:
<img src="./showcases/php.png">
2016-08-30 23:34:40 +12:00
Erlang:
2017-09-29 01:13:33 +13:00
<img src="./showcases/erlang.png">
2016-08-30 23:34:40 +12:00
Elixir:
2017-09-29 01:13:33 +13:00
<img src="/showcases/elixir.png">
2016-08-30 23:34:40 +12:00
Go:
2017-09-29 01:13:33 +13:00
<img src="./showcases/go.png">
2016-08-30 23:34:40 +12:00
LiveScript:
2017-09-29 01:13:33 +13:00
<img src="./showcases/livescript.png">
2016-08-30 23:34:40 +12:00
Clojure:
2017-09-29 01:13:33 +13:00
<img src="./showcases/clojure.png">
2016-08-30 23:34:40 +12:00
Swift:
2017-08-08 01:27:23 +12:00
2017-09-29 01:13:33 +13:00
<img src="./showcases/swift.png">
### Stylistic sets
2019-09-10 05:39:53 +12:00
See [How to enable](https://github.com/tonsky/FiraCode/wiki/How-to-enable-stylistic-sets)
<img src="./showcases/stylistic_sets.png">
2016-08-30 23:34:40 +12:00
2016-03-24 14:24:28 +13:00
### Terminal support
2015-12-21 03:51:56 +13:00
2017-11-02 23:27:48 +13:00
| Works | Doesnt work |
| ------------------ | ------------------ |
| **Butterfly** | **Alacritty** |
| **crosh** (ChromeOS, [instructions](https://github.com/tonsky/FiraCode/wiki/ChromeOS-Terminal)) | **Windows Console (conhost.exe)** |
| **Hyper.app** | **Cmder** |
| **iTerm 2** ([3.1+](https://gitlab.com/gnachman/iterm2/issues/3568#note_13118332)) | **ConEmu** |
| **Kitty** | **GNOME Terminal** |
| **Konsole** | **mate-terminal** |
| **mintty** (partial support [2.8.3+](https://github.com/mintty/mintty/issues/601))| **PuTTY** |
| **QTerminal** | **rxvt** |
2019-06-10 03:17:25 +12:00
| **Terminal.app** | **xterm** |
| **Termux** | **ZOC** (Windows) |
| **Token2Shell/MD** | **gtkterm, guake, LXTerminal, sakura, Terminator, xfce4-terminal,** and other libvte-based terminals ([bug report](https://bugzilla.gnome.org/show_bug.cgi?id=584160)) |
2018-07-04 21:10:26 +12:00
| **upterm** |
| **Windows Terminal** |
2018-07-04 21:10:26 +12:00
| **ZOC** (macOS) |
2015-12-21 03:51:56 +13:00
2014-11-12 08:47:04 +13:00
### Editor support
| Works | Doesnt work |
| ----- | -------------- |
| **Abricotine** | **Arduino IDE** |
| **Android Studio** (2.3+, [instructions](https://github.com/tonsky/FiraCode/wiki/Intellij-products-instructions)) | **Adobe Dreamweaver** |
| **Anjuta** (unless at the EOF) | **Delphi IDE** |
| **AppCode** (2016.2+, [instructions](https://github.com/tonsky/FiraCode/wiki/Intellij-products-instructions)) | **Eclipse** (Windows, [vote here](https://bugs.eclipse.org/bugs/show_bug.cgi?id=398656)) |
| **Atom** 1.1 or newer ([instructions](https://github.com/tonsky/FiraCode/wiki/Atom-instructions)) | Standalone **Emacs** ([workaround](https://github.com/tonsky/FiraCode/wiki/Emacs-instructions)) |
| **BBEdit/TextWrangler** (v. 11 only, [instructions](https://github.com/tonsky/FiraCode/wiki/BBEdit-instructions)) | **Geany** (Windows) |
| **Brackets** (with [this plugin](https://github.com/polo2ro/firacode-in-brackets)) | **gVim** (Windows [workaround](https://github.com/tonsky/FiraCode/issues/462)) |
| **Chocolat** | **IDLE** |
| **CLion** (2016.2+, [instructions](https://github.com/tonsky/FiraCode/wiki/Intellij-products-instructions)) | **KDevelop 4** |
| **Cloud9** ([instructions](https://github.com/tonsky/FiraCode/wiki/Cloud9-Instructions)) | **Monkey Studio IDE** |
| **Coda 2** | |
| **CodeLite** | |
| **Eclipse** (macOS 4.7+, Linux) | |
2018-05-03 02:39:10 +12:00
| **elementary Code** | |
| **Geany** (macOS) |
| **gEdit / Pluma** |
| **GNOME Builder** |
| **GoormIDE** ([instructions](https://github.com/tonsky/FiraCode/wiki/GoormIDE-Instructions)) |
| **IntelliJ IDEA** (2016.2+, [instructions](https://github.com/tonsky/FiraCode/wiki/Intellij-products-instructions)) |
| **Kate, KWrite** |
2019-06-03 22:22:45 +12:00
| **KDevelop 5+** |
| **Komodo** |
| **Leafpad** |
| **LibreOffice** |
| **LightTable** ([instructions](https://github.com/tonsky/FiraCode/wiki/LightTable-instructions)) |
| **LINQPad** |
| **MacVim** 7.4 or newer ([instructions](https://github.com/tonsky/FiraCode/wiki/MacVim-instructions)) |
| **Mancy** |
| **Meld** |
| **Mousepad** |
2018-03-13 22:51:38 +13:00
| **NeoVim-gtk** |
| **NetBeans** |
| **Notepad** (Windows) |
| **Notepad++** (with a [workaround](https://github.com/notepad-plus-plus/notepad-plus-plus/issues/2287#issuecomment-256638098)) |
2019-11-16 01:32:53 +13:00
| **Notepad3** ([instructions](https://github.com/rizonesoft/Notepad3/issues/361#issuecomment-365977420))|
| **PhpStorm** (2016.2+, [instructions](https://github.com/tonsky/FiraCode/wiki/Intellij-products-instructions)) |
| **PyCharm** (2016.2+, [instructions](https://github.com/tonsky/FiraCode/wiki/Intellij-products-instructions)) |
| **QtCreator** |
| **Rider** |
| **RStudio** ([instructions](https://github.com/tonsky/FiraCode/wiki/RStudio-instructions)) |
| **RubyMine** (2016.2+, [instructions](https://github.com/tonsky/FiraCode/wiki/Intellij-products-instructions)) |
| **Scratch** |
2019-01-03 05:22:28 +13:00
| **Scribus** (1.5.3+) |
| **SublimeText** (3146+) |
2017-03-31 02:23:15 +13:00
| **Spyder IDE** (only with Qt5) |
| **SuperCollider 3** |
| **TextAdept** (Linux, macOS) |
| **TextEdit** |
| **TextMate 2** |
| **VimR** ([instructions](https://github.com/qvacua/vimr/wiki#ligatures)) |
2019-05-31 23:12:26 +12:00
| **Visual Studio** (2015+, [instructions](https://github.com/tonsky/FiraCode/wiki/Visual-Studio-Instructions)) |
| **Visual Studio Code** ([instructions](https://github.com/tonsky/FiraCode/wiki/VS-Code-Instructions)) |
| **WebStorm** (2016.2+, [instructions](https://github.com/tonsky/FiraCode/wiki/Intellij-products-instructions)) |
| **Xamarin Studio/Monodevelop** |
2017-08-08 01:27:23 +12:00
| **Xcode** (8.0+, otherwise [with plugin](https://github.com/robertvojta/LigatureXcodePlugin)) |
| Probably work: **Smultron, Vico** | Under question: **Code::Blocks IDE** |
2014-11-12 08:47:04 +13:00
### Browser support
2015-05-08 02:41:30 +12:00
```html
<!-- HTML -->
2019-07-17 02:42:49 +12:00
<link rel="stylesheet" href="https://cdn.jsdelivr.net/gh/tonsky/FiraCode@1.207/distr/fira_code.css">
```
```css
/* CSS */
2019-07-17 02:42:49 +12:00
@import url(https://cdn.jsdelivr.net/gh/tonsky/FiraCode@1.207/distr/fira_code.css);
```
```css
/* Specify in CSS */
code { font-family: 'Fira Code', monospace; }
@supports (font-variation-settings: normal) {
code { font-family: 'Fira Code VF', monospace; }
}
```
- IE 10+, Edge: enable with `font-feature-settings: "calt";`
- Firefox
2015-12-20 21:20:33 +13:00
- Safari
- Chromium-based browsers (Chrome, Opera)
2015-12-22 09:12:16 +13:00
- ACE
- CodeMirror (enable with `font-variant-ligatures: contextual;`)
2016-07-19 03:02:34 +12:00
2017-02-16 08:07:49 +13:00
### Projects using Fira Code
- All [JetBrains products](https://www.jetbrains.com/)
2017-02-16 22:17:37 +13:00
- [CodePen](https://codepen.io/)
2017-02-16 08:07:49 +13:00
- [Blink Shell](http://www.blink.sh/)
- [Klipse](http://app.klipse.tech/)
- [IlyaBirman.net](http://ilyabirman.net/)
- [EvilMartians.com](https://evilmartians.com/)
- [Web Maker](https://webmakerapp.com/)
- [FromScratch](https://fromscratch.rocks/)
- [PEP20.org](https://pep20.org/)
2016-07-19 03:02:34 +12:00
### Alternatives
2016-02-09 17:15:29 +13:00
Other monospaced fonts with ligatures:
- [Hasklig](https://github.com/i-tu/Hasklig) (free)
- [PragmataPro](http://www.fsd.it/fonts/pragmatapro.htm) (€59)
- [Monoid](http://larsenwork.com/monoid/) (free)
2016-05-06 22:50:37 +12:00
- [Fixedsys Excelsior](https://github.com/kika/fixedsys) (free)
- [Iosevka](https://be5invis.github.io/Iosevka/) (free)
- [DejaVu Sans Code](https://github.com/SSNikolaevich/DejaVuSansCode) (free)
- [Victor Mono](https://rubjo.github.io/victor-mono/) (free)
- [Cascadia Code](https://github.com/microsoft/cascadia-code) (free)
### Building Fira Code locally
2019-04-05 09:05:55 +13:00
In case you want to alter FiraCode.glyphs and build OTF/TTF/WOFF files yourself, this is setup I use on macOS:
2019-04-05 09:05:55 +13:00
```bash
# install all required build tools
./script/bootstrap
2019-04-05 09:05:55 +13:00
# build the font files
./script/build
# install OTFs to ~/Library/Fonts
./script/install
```
2019-04-05 09:05:55 +13:00
2014-11-12 08:47:04 +13:00
### Credits
2016-04-17 03:16:36 +12:00
- Author: Nikita Prokopov [@nikitonsky](https://twitter.com/nikitonsky)
- Based on: [Fira Mono](https://github.com/mozilla/Fira)
- Inspired by: [Hasklig](https://github.com/i-tu/Hasklig)