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

282 lines
9.4 KiB
Markdown
Raw Normal View History

2014-11-12 08:47:04 +13:00
## Fira Code: monospaced font with programming ligatures
2015-07-31 00:27:45 +12:00
<img src="https://dl.dropboxusercontent.com/u/561580/imgs/fira_code_logo.svg">
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
2016-11-06 08:42:10 +13: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) · [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
2016-07-17 19:11:20 +12:00
Works | Doesnt work
---------------- | ---------------
**Black Screen** | **Cmder**
**Butterfly** | **ConEmu**
**Hyper.app** | **GNOME Terminal**
**Konsole** | **iTerm 2** ([coming in 3.1](https://gitlab.com/gnachman/iterm2/issues/3568#note_13118332))
**QTerminal** | **mate-terminal**
**Terminal.app** (OS X default terminal) | **mintty**
**Termux** (Android terminal emulator) | **PuTTY**
| **rxvt**
| **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
2015-12-21 03:51:56 +13:00
--------|----------------
2016-04-17 03:16:36 +12:00
**Anjuta** (unless at the EOF) | **Arduino IDE**
**AppCode** (2016.2+, [instructions](https://github.com/tonsky/FiraCode/wiki/Intellij-products-instructions)) | **Adobe Dreamweaver**
**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**
**Coda 2** | **Monkey Studio IDE**
2016-08-01 18:47:02 +12:00
**CodeLite** | **Notepad++**
**Eclipse** (Linux) | **Spyder IDE**
**Geany** | **SublimeText** ([vote here](http://sublimetext.userecho.com/topic/1030059-does-sublimetext-support-programming-ligatures-fontlike-fira-code/))
**gEdit / Pluma** |
**GNOME Builder** |
**IntelliJ IDEA** (2016.2+, [instructions](https://github.com/tonsky/FiraCode/wiki/Intellij-products-instructions)) |
**Kate, KWrite** |
2016-04-20 22:46:57 +12:00
**Komodo** |
2015-12-21 03:51:56 +13:00
**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)) |
2016-02-17 21:37:32 +13:00
**Scratch** |
**TextAdept** (Linux, Mac) |
**TextEdit** |
**TextMate 2** |
**Visual Studio 2015** |
2016-02-09 21:38:53 +13:00
**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/)
- [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)
2014-11-12 08:47:04 +13:00
### Changelog
2016-11-06 08:42:10 +13:00
#### 1.204 (November 6, 2016)
- Added `U+25B6` (black right-pointing triangle) and `U+25C0` (black left-pointing triangle) (#289)
- Changed look of Markdown headers `##` `###` `####` to make them easier to tell apart (#287)
- Fixed BBEdit incorrectly applying ligatures after tab (#274)
- Returned Nim pragmas `{.` `.}` (#279)
- Added Unicode increment `U+2206` (#174, #298)
- Added fish operators `>->` `<-<` (#297)
- Added safe navigation operators `?.` `.?` `?:` (#215)
- Added `<~>` (#179, used in IntelliJ for collapsed methods)
- Added F# piping operators `||>` `|||>` `<||` `<|||` (#184)
- Added shebang `#!` (#169, #193)
#### 1.203 (September 17, 2016)
- Added `__` (#120, #269)
2016-09-18 00:22:48 +12:00
#### 1.202 (September 17, 2016)
- Removed `{.` `.}` `[.` `.]` `(.` `.)` (#264)
#### 1.201 (August 30, 2016)
- Removed `[]` (#92) `{-` `-}` (#248)
- Removed `/**` `**/` and disabled ligatures for `/*/` `*/*` sequences (#219 #238)
- Added `]#` `{.` `.}` `[.` `.]` `(.` `.)` (#214)
2016-07-19 03:02:34 +12:00
#### 1.200 (July 18, 2016)
- Removed `!!!` `???` `;;;` `&&&` `|||` `=~` (#167) `~~~` `%%%`
- New safer `calt` code that doesnt apply ligatures to long sequences of chars, e.g. `!!!!`, `>>>>`, etc (#49, #110, #176)
- Larger `+` `-` `*` and corresponding ligatures (#86)
- Hexadecimal `x` (`0xFF`) is now applied to sequences like `128x128` as well (#161)
- Added twoTurned (U+218A) and threeTurned (U+218B) (#146)
- Added whiteFrowningFace (U+2639) (#190)
- Simplified visual style on markdown headers `##` `###` `####` (#107)
2016-07-17 23:39:17 +12:00
- Added `</>` (#147)
- Provided ttf and webfonts versions (eot, woff, woff2) (#18, #24, #38, #101, #106)
- Increased spacing in `<=` `>=` (#117)
2015-12-27 03:44:28 +13:00
#### 1.102
2015-12-27 03:51:05 +13:00
- Support for IntelliJ-based IDEs ([instructions](https://github.com/tonsky/FiraCode/wiki/Intellij-products-instructions))
2015-12-27 03:44:28 +13:00
- Turned on autohinting
#### 1.101
- Added Light weight
- Adjusted rules when vertical centering of `:`, `-`, `*` and `+` occurs
2015-12-20 06:26:39 +13:00
#### 1.100
- Fixed calt table conflicts (`----` would incorrectly render as `<!--`)
- Added centered `:` (between digits, e.g. `10:40`)
- Added lowercase-aligned `-`, `*` and `+` (only between lowercase letters, e.g. kebab case `var-name`, pointers `*ptr` etc)
2015-12-19 01:48:45 +13:00
#### 1.000
2015-12-19 01:36:42 +13:00
Added weights:
2015-12-19 01:48:45 +13:00
- Retina (just slightly heavier than Regular)
2015-12-19 01:36:42 +13:00
- Medium
- Bold
Switched to `calt` instead of `liga`. You can now “step inside” the ligature in text editors.
Fira Code is now drawn and built in Glyphs 2 app (should improve compatibility).
2015-12-19 01:36:42 +13:00
Added:
2015-12-19 01:43:42 +13:00
`<->` `<~~` `<~` `~~~` `~>` `~~>`
`<$` `<+` `<*` `*>` `+>` `$>`
`;;;` `:::` `!!!` `???` `%%` `%%%` `##` `###` `####`
`.-` `#_(` `=<` `**/` `0x` `www` `[]`
2015-12-19 01:36:42 +13:00
Redrawn:
`{-` `-}` `~=` `=~` `=<<` `>>=` `<$>` `<=>` `.=`
Removed: `?:`
Total ligatures count: 115
2015-12-19 01:48:45 +13:00
#### 0.6
2015-08-10 08:36:48 +12:00
2015-08-10 08:56:41 +12:00
Redrawn from Fira Mono 3.204 (slightly heavier weight)
2015-08-10 08:36:48 +12:00
2015-08-10 08:56:41 +12:00
Added:
`**` `***` `+++` `--` `---` `?:`
`/=` `/==` `.=` `^=` `=~` `?=` `||=` `|=`
`<<<` `<=<` `-<<` `-<` `>-` `>>-` `>=>` `>>>`
`<*>` `<|>` `<$>` `<+>`
2015-08-10 19:58:48 +12:00
`<!--` `{-` `-}` `/**` `\\` `\\\`
`..<` `??` `|||` `&&&` `<|` `|>`
2015-12-19 01:48:45 +13:00
Added support for Powerline
2015-08-10 08:36:48 +12:00
2015-12-19 01:48:45 +13:00
#### 0.5
2015-05-27 04:34:51 +12:00
2015-12-19 01:48:45 +13:00
Added: `#{` `~-` `-~` `<==` `==>` `///` `;;` `</`
#### 0.4
2015-05-26 07:52:15 +12:00
- Added `~=` `~~` `#[`
- Rolled back `&&` and `||` to more traditional look
- `===` and `!==` are now rendered with 3 horizontal bars
2015-05-26 07:52:15 +12:00
2015-05-08 03:57:07 +12:00
2015-12-19 01:48:45 +13:00
#### 0.3
Added: `~@` `#?` `=:=` `=<`
#### 0.2.1
Fixed width of `&&` and `||`
#### 0.2
Added: `-->` `<--` `&&` `||` `=>>` `=/=`
2015-05-08 03:57:07 +12:00
2015-05-08 02:41:30 +12:00
2015-12-19 01:48:45 +13:00
#### 0.1
2014-11-12 08:47:04 +13:00
`>>=` `=<<` `<<=` `->>` `->` `=>` `<<-` `<-`
`===` `==` `<=>` `>=` `<=` `>>` `<<` `!==` `!=` `<>`
`:=` `++` `#(` `#_`
`::` `...` `..` `!!` `//` `/*` `*/` `/>`