1
0
Fork 0
mirror of synced 2024-06-03 11:14:57 +12:00
FiraCode/README.md

138 lines
4.5 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">
2015-08-10 08:36:48 +12:00
#### [Download Fira Code v0.6](https://github.com/tonsky/FiraCode/releases/download/0.6/FiraCode-Regular.otf)
2015-05-08 02:41:30 +12:00
2014-11-12 08:47:04 +13:00
### Problem
2015-05-23 01:30:32 +12:00
Programmers use a lot of symbols, often encoded with several characters. For human brain sequences like `->`, `<=` or `:=` are single logical token, even if they take two or three places on the screen. Your eye spends 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
Fira Code is a Fira Mono font extended with 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.
### Fira Code (with ligatures):
2015-05-26 07:52:15 +12:00
<img src="./showcases/all_ligatures.png" />
2014-11-12 08:47:04 +13:00
Compare to Fira Mono (without ligatures):
2015-05-26 07:52:15 +12:00
<img src="./showcases/no_ligatures.png" />
2014-11-12 08:47:04 +13:00
### Editor support
Do **not** work:
- SublimeText ([vote here](http://sublimetext.userecho.com/topic/433445-opentype-support-ligatures-curly-quotes-contextual-and-alternate-symbols/))
2015-10-08 07:24:44 +13:00
- Intellij Idea ([vote here](https://youtrack.jetbrains.com/issue/IDEA-127539)), including everything built on top of it (PhpStorm, PyCharm, RubyMine, WebStorm, AppCode, CLion, ReSharper)
- iTerm 2 ([feature request](https://gitlab.com/gnachman/iterm2/issues/3568))
- OS X Terminal.app
2015-10-19 04:47:46 +13:00
- Emacs ([workaround](https://github.com/tonsky/FiraCode/wiki/Setting-up-Emacs))
- gVim, MacVim
- Eclipse (Mac and Win, [vote here](https://bugs.eclipse.org/bugs/show_bug.cgi?id=398656))
2015-09-12 00:25:07 +12:00
- Notepad++
- Kate, Konsole, KWrite in KDE 4
2015-09-17 05:07:35 +12:00
- Xamarin Studio/Monodevelop
Do work:
2015-10-30 20:19:55 +13:00
- Atom (since [1.1](http://blog.atom.io/2015/10/29/atom-1-1-is-out.html), add `atom-text-editor { text-rendering:optimizeLegibility }` to the stylesheet)
2015-11-07 08:33:07 +13:00
- Xcode (with [this plugin](https://github.com/robertvojta/LigatureXcodePlugin))
- Visual Studio
- TextMate 2
2015-09-12 00:25:07 +12:00
- Coda 2
- Eclipse (Linux)
- QtCreator
- LightTable ([instructions](https://github.com/LightTable/LightTable/issues/1459#issuecomment-57366504))
- BBEdit — enter this command in a terminal to enable ligatures:
`defaults write com.barebones.bbedit "EnableFontLigatures_Fira Code" -bool YES`
2015-08-10 08:36:48 +12:00
- RStudio
- Chocolat
- Kate, Konsole, KWrite in Plasma/KDE 5
- Kate, Konsole, KWrite in KDE 4 using Debian Jessie or OS X
Should work (copied from [Hasklig README](https://github.com/i-tu/Hasklig)):
- Geany
- gEdit
- Smultron
- Vico
2014-11-12 08:47:04 +13:00
2015-05-08 02:41:30 +12:00
_Note:_ Im not a font designer, and Fira Code is built in sort of [a hacky way](https://github.com/mozilla/Fira/issues/62) from OTF version of Fira Mono. Please forgive me if it doesnt work for you. Help will be greatly appreciated.
### 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
Haskell:
2015-05-26 07:52:15 +12:00
<img src="./showcases/haskell.png" />
2014-11-18 19:27:41 +13:00
### Alternatives
Another 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)
2014-11-12 08:47:04 +13:00
### Credits
2015-08-10 08:36:48 +12:00
This work is based on OFL-licensed [Fira Mono font](https://github.com/mozilla/Fira). Original Fira Mono font was not changed, only extended
2014-11-12 08:47:04 +13:00
Fira Code was inspired by [Hasklig font](https://github.com/i-tu/Hasklig): Ligatures for Haskell code
### Changelog
2015-08-10 08:36:48 +12:00
**0.6**:
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-08-10 08:36:48 +12:00
and Powerline support
2015-05-27 04:34:51 +12:00
**0.5**: `#{` `~-` `-~` `<==` `==>` `///` `;;` `</`
2015-05-26 07:52:15 +12:00
**0.4**:
- Added `~=` `~~` `#[`
- Rolled back `&&` and `||` to more traditional look
- `===` and `!==` are now rendered with 3 horisontal bars
2015-05-11 21:23:03 +12:00
**0.3**: `~@` `#?` `=:=` `=<`
2015-05-08 03:57:07 +12:00
**0.2.1**: Fixed width of `&&` and `||`
2015-05-08 03:57:07 +12:00
2015-05-11 21:23:03 +12:00
**0.2**: `-->` `<--` `&&` `||` `=>>` `=/=`
2015-05-08 02:41:30 +12:00
2015-05-11 21:23:03 +12:00
**0.1**
2014-11-12 08:47:04 +13:00
`>>=` `=<<` `<<=` `->>` `->` `=>` `<<-` `<-`
`===` `==` `<=>` `>=` `<=` `>>` `<<` `!==` `!=` `<>`
`:=` `++` `#(` `#_`
`::` `...` `..` `!!` `//` `/*` `*/` `/>`