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

152 lines
6.5 KiB
Markdown
Raw Normal View History

2014-11-12 08:47:04 +13:00
## Fira Code: monospaced font with programming ligatures
2017-03-20 21:50:13 +13:00
<img src="http://s.tonsky.me/imgs/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
2017-06-11 00:46:53 +12:00
#### [Download v1.204](https://github.com/tonsky/FiraCode/releases/download/1.204/FiraCode_1.204.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
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
2015-05-26 07:52:15 +12: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:
<img src="./showcases/ruby.png" />
JavaScript:
<img src="./showcases/javascript.png" />
Erlang:
<img src="./showcases/erlang.png" />
Elixir:
<img src="/showcases/elixir.png" />
2016-08-30 23:34:40 +12:00
Go:
<img src="./showcases/go.png" />
LiveScript:
<img src="./showcases/livescript.png" />
Clojure:
<img src="./showcases/clojure.png" />
2016-03-24 14:24:28 +13:00
### Terminal support
2015-12-21 03:51:56 +13:00
| Works | Doesnt work |
| ---------------- | ------------------ |
2017-06-01 06:49:44 +12:00
| **Black Screen** | **cmd.exe* |
| **Butterfly** | **Cmder** |
| **Hyper.app** | **ConEmu** |
| **Konsole** | **GNOME Terminal** |
| **QTerminal** | **iTerm 2** ([coming in 3.1](https://gitlab.com/gnachman/iterm2/issues/3568#note_13118332)) |
| **Terminal.app** (OS X default terminal) | **mate-terminal** |
| **Termux** (Android terminal emulator) | **mintty** |
2017-06-13 05:55:24 +12:00
| **ZOC** (macOS) | **PuTTY** |
2017-06-01 06:49:44 +12:00
| | **rxvt** |
2017-06-13 05:55:24 +12:00
| | **ZOC** (Windows) |
| | **gtkterm, guake, LXTerminal, sakura, Terminator, xfce4-terminal,** and other libvte-based terminals ([bug report](https://bugzilla.gnome.org/show_bug.cgi?id=584160)) |
2015-12-21 03:51:56 +13:00
2014-11-12 08:47:04 +13:00
### Editor support
| Works | Doesnt work |
| ----- | -------------- |
| **Android Studio** (2.3+, [instructions](https://github.com/tonsky/FiraCode/wiki/Intellij-products-instructions)) | **Arduino IDE** |
| **Anjuta** (unless at the EOF) | **Adobe Dreamweaver** |
| **AppCode** (2016.2+, [instructions](https://github.com/tonsky/FiraCode/wiki/Intellij-products-instructions)) | **Delphi IDE** |
| **Atom** 1.1 or newer ([instructions](https://github.com/tonsky/FiraCode/wiki/Atom-instructions)) | **Eclipse** (Mac and Win, [vote here](https://bugs.eclipse.org/bugs/show_bug.cgi?id=398656)) |
| **BBEdit/TextWrangler** ([instructions](https://github.com/tonsky/FiraCode/wiki/BBEdit-instructions)) | Standalone **Emacs** ([workaround](https://github.com/tonsky/FiraCode/wiki/Setting-up-Emacs)) |
| **Brackets** (with [this plugin](https://github.com/polo2ro/firacode-in-brackets)) | **gVim** |
| **Chocolat** | **IDLE** |
| **CLion** (2016.2+, [instructions](https://github.com/tonsky/FiraCode/wiki/Intellij-products-instructions)) | **KDevelop 4** |
| **Cloud9** | **Monkey Studio IDE** |
| **Coda 2** | **Notepad++** |
| **CodeLite** | **SublimeText** ([vote here](http://sublimetext.userecho.com/topic/1030059-does-sublimetext-support-programming-ligatures-fontlike-fira-code/)) |
| **Eclipse** (Linux) | |
| **Geany** |
| **gEdit / Pluma** |
| **GNOME Builder** |
| **IntelliJ IDEA** (2016.2+, [instructions](https://github.com/tonsky/FiraCode/wiki/Intellij-products-instructions)) |
| **Kate, KWrite** |
| **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** |
| **NetBeans** |
| **Notepad** (Win) |
| **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** |
2017-03-31 02:23:15 +13:00
| **Spyder IDE** (only with Qt5) |
| **TextAdept** (Linux, Mac) |
| **TextEdit** |
| **TextMate 2** |
| **VimR** ([instructions](https://github.com/qvacua/vimr/wiki#ligatures)) |
2017-04-27 23:45:41 +12:00
| **Visual Studio 2015** |
| **Visual Studio 2017** |
| **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** |
| **Xcode** (with [this 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
2015-12-21 00:15:24 +13:00
- IE 10+, Edge: enable with `font-feature-settings: "calt" 1;`
- 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/)
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)
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)
- Software: [Glyphs 2](https://glyphsapp.com) (thx Georg Seifert for a license)