nerd-fonts/patched-fonts/SourceCodePro/Medium/readme.md

86 lines
4.4 KiB
Markdown
Raw Normal View History

2020-01-27 06:55:13 +01:00
# Source Code Pro
2017-11-18 22:15:49 +01:00
2020-01-27 06:55:13 +01:00
Source Code Pro is a set of OpenType fonts that have been designed to work well
in user interface (UI) environments. In addition to a functional OpenType font, this open
source project provides all of the source files that were used to build this OpenType font
by using the AFDKO makeotf tool.
2017-11-18 22:15:49 +01:00
2020-01-27 06:55:13 +01:00
## Font installation instructions
2017-11-18 22:15:49 +01:00
2020-01-27 06:55:13 +01:00
* [Mac OS X](http://support.apple.com/kb/HT2509)
* [Windows](https://www.microsoft.com/en-us/Typography/TrueTypeInstall.aspx)
* [Linux/Unix-based systems](https://github.com/adobe-fonts/source-code-pro/issues/17#issuecomment-8967116)
* Bower<br/>
`bower install git://github.com/adobe-fonts/source-code-pro.git#release`
* npm 2.x<br/>
`npm install --fetch-only git://github.com/adobe-fonts/source-code-pro.git#release`
* npm 3.x<br/>
`npm install git://github.com/adobe-fonts/source-code-pro.git#release`
2017-11-18 22:15:49 +01:00
2020-01-27 06:55:13 +01:00
## Getting Involved
2017-11-18 22:15:49 +01:00
2020-01-27 06:55:13 +01:00
Send suggestions for changes to the Source Code OpenType font project maintainer, [Paul D. Hunt](mailto:opensourcefonts@adobe.com?subject=[GitHub] Source Code Pro), for consideration.
2017-11-18 22:15:49 +01:00
2020-01-27 06:55:13 +01:00
## Further information
2017-11-18 22:15:49 +01:00
2020-01-27 06:55:13 +01:00
For information about the design and background of Source Code, please refer to the [official font readme file](http://www.adobe.com/products/type/font-information/source-code-pro-readme.html).
2017-08-05 01:13:06 +02:00
## Why `Sauce` and not `Source`?
2022-01-04 06:43:04 +01:00
What's in a name? The reason for the name change is to comply with the SIL Open Font License (OFL), in particular the [Reserved Font Name mechanism][SIL-RFN]
2017-08-05 01:13:06 +02:00
Some fonts have parts of their name "reserved" per the [Reserved Font Name mechanism][SIL-RFN]:
> No Modified Version of the Font Software may use the Reserved Font
> Name(s) unless explicit written permission is granted by the corresponding
> Copyright Holder. This restriction only applies to the primary font name as
> presented to the users.
- The main goals seem to be to: `Avoid collisions`, `Protect authors`, `Minimize support`, and `Encourage derivatives`
See the [Reserved Font Name section][SIL-RFN] for additional information
## Which font?
### TL;DR
2017-08-05 01:13:06 +02:00
* Pick your font family and then select from the `'complete'` directory.
* If you are on Windows pick a font with the `'Windows Compatible'` suffix.
* This includes specific tweaks to ensure the font works on Windows, in particular monospace identification and font name length limitations
* If you are limited to monospaced fonts (because of your terminal, etc) then pick a font with the `'Mono'` suffix.
2023-01-17 20:07:49 +01:00
* If you want to have bigger icons (usually around 1.5 normal letters wide) pick a font without `'Mono'` suffix. Most terminals support this, but ymmv.
### Ligatures
2023-01-17 20:07:49 +01:00
Ligatures are generally preserved in the patched fonts.
Nerd Fonts `v2.0.0` had no ligatures in the `Nerd Font Mono` fonts, this has been dropped with `v2.1.0`.
If you have a ligature-aware terminal and don't want ligatures you can (usually) disable them in the terminal settings.
### Explanation
2017-08-05 01:13:06 +02:00
Once you narrow down your font choice of family (`Droid Sans`, `Inconsolata`, etc) and style (`bold`, `italic`, etc) you have 2 main choices:
#### `Option 1: Download already patched font`
2023-01-17 20:07:49 +01:00
* For a stable version download a font package from the [release page](https://github.com/ryanoasis/nerd-fonts/releases)
* Or download the development version from the `complete` folder here
2017-08-05 01:13:06 +02:00
#### `Option 2: Patch your own font`
* patch your own variations with the various options provided by the font patcher (see each font's readme for full list of combinations available)
2017-08-05 01:13:06 +02:00
* This is the option you want if the font you use is _not_ already included or you want maximum control of what's included
2023-01-17 20:07:49 +01:00
* This contains a list of _all permutations_ of the various glyphs. E.g. You want the font with only [Octicons][octicons] or you want the font with just [Font Awesome][font-awesome] and [Devicons][vorillaz-devicons].
2017-07-28 22:29:44 +02:00
For more information see: [The FAQ](https://github.com/ryanoasis/nerd-fonts/wiki/FAQ-and-Troubleshooting#which-font)
[vim-devicons]:https://github.com/ryanoasis/vim-devicons
2017-07-28 22:29:44 +02:00
[vorillaz-devicons]:https://vorillaz.github.io/devicons/
[font-awesome]:https://github.com/FortAwesome/Font-Awesome
2017-07-28 22:29:44 +02:00
[octicons]:https://github.com/primer/octicons
[gabrielelana-pomicons]:https://github.com/gabrielelana/pomicons
[Seti-UI]:https://atom.io/themes/seti-ui
[ryanoasis-powerline-extra-symbols]:https://github.com/ryanoasis/powerline-extra-symbols
2017-08-05 01:13:06 +02:00
[SIL-RFN]:http://scripts.sil.org/cms/scripts/page.php?item_id=OFL_web_fonts_and_RFNs#14cbfd4a