diff --git a/README.txt b/README.txt index d5ae1b1..c222865 100644 --- a/README.txt +++ b/README.txt @@ -1,563 +1,5 @@ -Installing -========== - -Windows -------- - -In the ttf folder, double-click each font file, click “Install font”; to install all at once, select all files, right-click, and choose “Install” - -OR - -Use https://chocolatey.org: - - choco install firacode - - -macOS ------ - -In the downloaded TTF folder: - -1. Select all font files -2. Right click and select `Open` (alternatively `Open With Font Book`) -3. Select "Install Font" - -OR - -Use http://brew.sh: - - `brew tap homebrew/cask-fonts` - `brew install font-fira-code` - - -Ubuntu Zesty (17.04), Debian Stretch (9) or newer -------------------------------------------------- - -1. Make sure that the `universe` (for Ubuntu) or `contrib` (for Debian) repository is enabled (see https://askubuntu.com/questions/148638/how-do-i-enable-the-universe-repository or https://wiki.debian.org/SourcesList#Component) -2. Install `fonts-firacode` package either by executing `sudo apt install fonts-firacode` in the terminal or via GUI tool (like “Software Center”) - - -Arch Linux ----------- - -Fira Code package is available in the official repository: https://www.archlinux.org/packages/community/any/ttf-fira-code/. - -Variant of Fira Code package is available in the AUR: https://aur.archlinux.org/packages/otf-fira-code-git/. - - -Gentoo ------- - - emerge -av media-fonts/fira-code - - -Fedora ------- - -To install, perform the following commands: - - dnf install fira-code-fonts - - -Solus ------ - -Fira Code package is available in the official repository: `font-firacode-ttf` and `font-firacode-otf`. -They can be installed by running: - - sudo eopkg install font-firacode-ttf font-firacode-otf - - -Void linux ----------- - - xbps-install font-firacode - - -Linux Manual Installation -------------------------- - -With most desktop-oriented distributions, double-clicking each font file in the ttf folder and selecting “Install font” should be enough. If it isn’t, create and run `download_and_install.sh` script: - - #!/usr/bin/env bash - - fonts_dir="${HOME}/.local/share/fonts" - if [ ! -d "${fonts_dir}" ]; then - echo "mkdir -p $fonts_dir" - mkdir -p "${fonts_dir}" - else - echo "Found fonts dir $fonts_dir" - fi - - for type in Bold Light Medium Regular Retina; do - file_path="${HOME}/.local/share/fonts/FiraCode-${type}.ttf" - file_url="https://github.com/tonsky/FiraCode/blob/master/distr/ttf/FiraCode-${type}.ttf?raw=true" - if [ ! -e "${file_path}" ]; then - echo "wget -O $file_path $file_url" - wget -O "${file_path}" "${file_url}" - else - echo "Found existing file $file_path" - fi; - done - - echo "fc-cache -f" - fc-cache -f - -More details: https://github.com/tonsky/FiraCode/issues/4 - - -FreeBSD -------- - -Using pkg(8): - - pkg install firacode - -OR - -Using ports: - - cd /usr/ports/x11-fonts/firacode && make install clean - - -Enabling ligatures -================== - -Atom ----- - -To change your font to Fira Code, open Atom's preferences (`cmd + ,` on a Mac, `ctrl + ,` on PC), make sure the "Settings" tab is selected, or the "Editor" in Atom 1.10+, and scroll down to "Editor Settings". In the "Font Family" field, enter `Fira Code`. - -If you wish to specify a font weight, for example, Light, use `Fira Code Light` as a font name (Windows) or `FiraCode-Light` (macOS). - -Ligatures are enabled by default in Atom 1.9 and above. - - -VS Code -------- - -To open the settings editor, first from the File menu choose Preferences, Settings or use keyboard shortcut `Ctrl + ,` (Windows) or `Cmd + ,` (macOS). - -To enable FiraCode in the settings editor, under "Commonly Used", expand the "Text Editor" settings and then click on "Font". In the "Font Family" input box type `Fira Code`, replacing any content. Tick the check box "Enables/Disables font ligatures" under "Font Ligatures" to enable the special ligatures. - -If you wish to specify a font weight, for example, Light, use `Fira Code Light` as a font name (Windows) or `FiraCode-Light` (macOS). - - -IntelliJ products ------------------ - -1. Enable in Settings → Editor → Font → Enable Font Ligatures -2. Select `Fira Code` as "Primary font" under Settings → Editor → Font - -Additionally, if a Color Scheme is selected: - -3. Enable in Settings → Editor → Color Scheme → Color Scheme Font → Enable Font Ligatures -4. Select Fira Code as "Primary font" under Settings → Editor → Color Scheme → Color Scheme Font - - -BBEdit, TextWrangler --------------------- - -Run in your terminal: - - defaults write com.barebones.bbedit "EnableFontLigatures_Fira Code" -bool YES - -Source: https://www.barebones.com/support/bbedit/ExpertPreferences.html - - -Brackets --------- - -1. From the `View` menu choose `Themes....` -2. Paste `'Fira Code'`, at the beginning of `Font Family` - - -Emacs ------ - -There are a few options when it comes down to using ligatures in -Emacs. They are listed in order of preferred to less-preferred. Pick one! - -1. Using composition mode in Emacs Mac port - -If you're using the latest Mac port of Emacs (https://bitbucket.org/mituharu/emacs-mac by Mitsuharu Yamamoto) for macOS, you can use: - - (mac-auto-operator-composition-mode) - -This is generally the easiest solution, but can only be used on macOS. - -2. Using prettify-symbols - -These instructions are pieced together by https://github.com/Triavanicus, taking some pieces from https://github.com/minad/hasklig-mode. - -This method requires you to install the Fira Code Symbol font, made by https://github.com/siegebell: -https://github.com/tonsky/FiraCode/issues/211#issuecomment-239058632 - - (defun fira-code-mode--make-alist (list) - "Generate prettify-symbols alist from LIST." - (let ((idx -1)) - (mapcar - (lambda (s) - (setq idx (1+ idx)) - (let* ((code (+ #Xe100 idx)) - (width (string-width s)) - (prefix ()) - (suffix '(?\s (Br . Br))) - (n 1)) - (while (< n width) - (setq prefix (append prefix '(?\s (Br . Bl)))) - (setq n (1+ n))) - (cons s (append prefix suffix (list (decode-char 'ucs code)))))) - list))) - - (defconst fira-code-mode--ligatures - '("www" "**" "***" "**/" "*>" "*/" "\\\\" "\\\\\\" - "{-" "[]" "::" ":::" ":=" "!!" "!=" "!==" "-}" - "--" "---" "-->" "->" "->>" "-<" "-<<" "-~" - "#{" "#[" "##" "###" "####" "#(" "#?" "#_" "#_(" - ".-" ".=" ".." "..<" "..." "?=" "??" ";;" "/*" - "/**" "/=" "/==" "/>" "//" "///" "&&" "||" "||=" - "|=" "|>" "^=" "$>" "++" "+++" "+>" "=:=" "==" - "===" "==>" "=>" "=>>" "<=" "=<<" "=/=" ">-" ">=" - ">=>" ">>" ">>-" ">>=" ">>>" "<*" "<*>" "<|" "<|>" - "<$" "<$>" "\\)" #Xe113) - ("[^-]\\(->\\)" #Xe114) - ("\\(->>\\)" #Xe115) - ("\\(-<\\)" #Xe116) - ("\\(-<<\\)" #Xe117) - ("\\(-~\\)" #Xe118) - ("\\(#{\\)" #Xe119) - ("\\(#\\[\\)" #Xe11a) - ("\\(##\\)" #Xe11b) - ("\\(###\\)" #Xe11c) - ("\\(####\\)" #Xe11d) - ("\\(#(\\)" #Xe11e) - ("\\(#\\?\\)" #Xe11f) - ("\\(#_\\)" #Xe120) - ("\\(#_(\\)" #Xe121) - ("\\(\\.-\\)" #Xe122) - ("\\(\\.=\\)" #Xe123) - ("\\(\\.\\.\\)" #Xe124) - ("\\(\\.\\.<\\)" #Xe125) - ("\\(\\.\\.\\.\\)" #Xe126) - ("\\(\\?=\\)" #Xe127) - ("\\(\\?\\?\\)" #Xe128) - ("\\(;;\\)" #Xe129) - ("\\(/\\*\\)" #Xe12a) - ("\\(/\\*\\*\\)" #Xe12b) - ("\\(/=\\)" #Xe12c) - ("\\(/==\\)" #Xe12d) - ("\\(/>\\)" #Xe12e) - ("\\(//\\)" #Xe12f) - ("\\(///\\)" #Xe130) - ("\\(&&\\)" #Xe131) - ("\\(||\\)" #Xe132) - ("\\(||=\\)" #Xe133) - ("[^|]\\(|=\\)" #Xe134) - ("\\(|>\\)" #Xe135) - ("\\(\\^=\\)" #Xe136) - ("\\(\\$>\\)" #Xe137) - ("\\(\\+\\+\\)" #Xe138) - ("\\(\\+\\+\\+\\)" #Xe139) - ("\\(\\+>\\)" #Xe13a) - ("\\(=:=\\)" #Xe13b) - ("[^!/]\\(==\\)[^>]" #Xe13c) - ("\\(===\\)" #Xe13d) - ("\\(==>\\)" #Xe13e) - ("[^=]\\(=>\\)" #Xe13f) - ("\\(=>>\\)" #Xe140) - ("\\(<=\\)" #Xe141) - ("\\(=<<\\)" #Xe142) - ("\\(=/=\\)" #Xe143) - ("\\(>-\\)" #Xe144) - ("\\(>=\\)" #Xe145) - ("\\(>=>\\)" #Xe146) - ("[^-=]\\(>>\\)" #Xe147) - ("\\(>>-\\)" #Xe148) - ("\\(>>=\\)" #Xe149) - ("\\(>>>\\)" #Xe14a) - ("\\(<\\*\\)" #Xe14b) - ("\\(<\\*>\\)" #Xe14c) - ("\\(<|\\)" #Xe14d) - ("\\(<|>\\)" #Xe14e) - ("\\(<\\$\\)" #Xe14f) - ("\\(<\\$>\\)" #Xe150) - ("\\( Settings - -Add before "ignored_packages": - - "font_face": "Fira Code", - "font_options": ["subpixel_antialias"], - -If you want enable antialias, add in font_options: "gray_antialias" - - -Visual Studio -------------- - -1. Launch Visual Studio (2015 or later). -2. Launch the Options dialog by opening the "Tools" menu and selecting "Options". -3. In the Options dialog, under the "Environment" category, you'll find "Fonts and Colors". Click on that. You'll see a combo-box on the right hand side of the dialog labelled "Font". Select "Fira Code" from that combo-box. -4. Click "OK" to dismiss. -5. Restart Visual Studio. - -Now, most FiraCode ligatures will work. A notable exception is the hyphen-based ligatures (e.g. the C++ dereference '->'). See https://github.com/tonsky/FiraCode/issues/422 for details. - - -Troubleshooting -=============== - -See https://github.com/tonsky/FiraCode/wiki/Troubleshooting +Dep: + sdl2-dev + sdl2_ttf + sdl2_image + gcc/clang