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

228 lines
7.3 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-07-17 00:33:21 +12:00
#### Download [Fira Code v1.102](https://github.com/tonsky/FiraCode/releases/download/1.102/FiraCode_1.102.zip) | Read [how to install](https://github.com/tonsky/FiraCode/wiki) | Follow updates 📢 [@FiraCode](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-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** | **GNOME Terminal**
2016-07-17 19:11:20 +12:00
**Butterfly** | **iTerm 2** ([feature request](https://gitlab.com/gnachman/iterm2/issues/3568))
**HyperTerm** | **rxvt**
**Konsole** | **xfce4-terminal**
**QTerminal** |
**Terminal.app** (OS X default terminal) |
**Termux** (Android terminal emulator) |
2016-07-17 19:11:20 +12:00
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**
**Atom** 1.1 or newer ([instructions](https://github.com/tonsky/FiraCode/wiki/Atom-instructions)) | **Adobe Dreamweaver**
**BBEdit** ([instructions](https://github.com/tonsky/FiraCode/wiki/BBEdit-instructions)) | **Eclipse** (Mac and Win, [vote here](https://bugs.eclipse.org/bugs/show_bug.cgi?id=398656))
**Brackets** (with [this plugin](https://github.com/polo2ro/firacode-in-brackets)) | Standalone **Emacs** ([workaround](https://github.com/tonsky/FiraCode/wiki/Setting-up-Emacs))
**Chocolat** | **gVim**
**Coda 2** | **IDLE**
**CodeLite** | **KDevelop 4**
**Eclipse** (Linux) | **Monkey Studio IDE**
**Geany** | **NetBeans**
**gEdit / Pluma** | **Notepad++**
**GNOME Builder** | **Spyder IDE**
**IntelliJ products** (IDEA etc, [instructions](https://github.com/tonsky/FiraCode/wiki/Intellij-products-instructions)) | **SublimeText** ([vote here](http://sublimetext.userecho.com/topic/1030059-does-sublimetext-support-programming-ligatures-fontlike-fira-code/))
**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)) |
**MacVim** 7.4 or newer ([instructions](https://github.com/tonsky/FiraCode/wiki/MacVim-instructions)) |
**Mancy** |
**Meld** |
**Mousepad** |
**Notepad** (Win) |
**QtCreator** |
**RStudio** ([instructions](https://github.com/tonsky/FiraCode/wiki/RStudio-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)) |
**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
2016-04-17 03:16:36 +12:00
- Chromium-based browsers (Chrome, Opera):
- enable with `font-variant-ligatures: contextual;` or `text-rendering: optimizeLegibility`, see [571246](https://code.google.com/p/chromium/issues/detail?q=font-variant-ligatures&id=571246&thanks=571246&ts=1450553433&)
2015-12-22 09:12:16 +13:00
- ACE
- CodeMirror
2015-05-08 02:41:30 +12:00
### Code examples
2014-11-18 19:27:41 +13:00
2015-05-26 08:04:21 +12:00
Ruby:
<img src="./showcases/ruby.png" />
JavaScript:
<img src="./showcases/javascript.png" />
2014-11-18 19:27:41 +13:00
Erlang:
2015-05-26 07:52:15 +12:00
<img src="./showcases/erlang.png" />
2014-11-18 19:27:41 +13:00
Go:
2015-05-26 07:52:15 +12:00
<img src="./showcases/go.png" />
2014-11-18 19:27:41 +13:00
2016-05-23 20:24:34 +12:00
LiveScript:
2014-11-18 19:27:41 +13:00
2016-05-23 20:24:34 +12:00
<img src="./showcases/livescript.png" />
2014-11-18 19:27:41 +13: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)
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
#### Work in progress
- 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
`<->` `<~~` `<~` `~~~` `~>` `~~>`
`<$` `<+` `<*` `*>` `+>` `$>`
`;;;` `:::` `!!!` `???` `%%` `%%%` `##` `###` `####`
2015-12-20 06:26:39 +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-08-10 08:56:41 +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
`>>=` `=<<` `<<=` `->>` `->` `=>` `<<-` `<-`
`===` `==` `<=>` `>=` `<=` `>>` `<<` `!==` `!=` `<>`
`:=` `++` `#(` `#_`
`::` `...` `..` `!!` `//` `/*` `*/` `/>`