mirror of
https://github.com/source-foundry/Hack.git
synced 2024-09-19 09:07:39 +03:00
Move obvious 'bloat' to separate documents
This commit is contained in:
burodepeper
parent
66afd78f91
commit
166afa13f7
275
README.md
275
README.md
@ -34,7 +34,6 @@ https://github.com/source-foundry/font-line
|
||||
|
||||
or [use one of our handy shell scripts](https://github.com/chrissimpkins/Hack/tree/master/tools/line-spacing) that automates the `font-line` install and line spacing modification process for a range of line spacing % UPM values between 10 - 30%. Select the script that fits your needs and execute it in the download directory that contains your .ttf and/or .otf font files **before you install them**.
|
||||
|
||||
|
||||
### About
|
||||
|
||||
No frills. No gimmicks. Hack is hand groomed and optically balanced to be a workhorse face for code.
|
||||
@ -51,289 +50,22 @@ The font binaries are released under a license that permits unlimited print, des
|
||||
- **Glyph Number**: 1561
|
||||
- **Included Styles**: Regular, Bold, Italic, Bold Italic
|
||||
|
||||
|
||||
### Specimen
|
||||
|
||||
<a href="http://chrissimpkins.github.io/Hack/font-specimen.html"><img src="img/hack-waterfall.png" alt="Hack font specimen" width="728"></a>
|
||||
|
||||
Click the image for the full type specimen.
|
||||
|
||||
<!-- TODO Installation -->
|
||||
|
||||
### Desktop Installation
|
||||
|
||||
Hack is available for download in either [OTF][otf_latest] or [TTF][ttf_latest] formats. The best format and install approach depends on your operating system. If you do not know which format is optimal for your system, the TTF files should be used as your default.
|
||||
|
||||
Because Hack is under active development and updates are released frequently we highly recommended using a package manager or other auto-updating utility. While the package manager releases may be a bit delayed relative to the repository releases, the package managers automate and simplify font updates on your system. Please note that the Hack packages in these package managers are not maintained by the Hack project developers. If you come across a problem with the release schedule in your package manager, please report it directly to the respective package maintainer on your platform.
|
||||
|
||||
#### OS X
|
||||
|
||||
The easiest way to install and update Hack on OS X is to use the [Homebrew](http://brew.sh/) package manager. To install the fonts on OS X use the command:
|
||||
|
||||
$ brew cask install caskroom/fonts/font-hack
|
||||
|
||||
|
||||
**OS X Users Please Note**: There has been a change in the Homebrew-Cask system that requires an update of `brew-cask`. If you encounter an error during your Hack install attempt, please execute the following command and then install with the above command again:
|
||||
|
||||
```
|
||||
$ brew uninstall --force brew-cask && brew update
|
||||
```
|
||||
|
||||
Please see [issue report #169](https://github.com/chrissimpkins/Hack/issues/169) for additional details.
|
||||
|
||||
To install the fonts manually you may use either the [OTF][otf_latest] or [TTF][ttf_latest] formats. Download the zip file and extract it. Double clicking each of the font files will open a preview in [Font Book](https://support.apple.com/en-us/HT201749) and the "Install Font" button will copy the font to the correct system location.
|
||||
|
||||
#### Linux / BSD
|
||||
|
||||
Most Linux and BSD systems can handle either [TTF][ttf_latest] or [OTF][otf_latest] format fonts. We are aware of package manager support on the following distros:
|
||||
|
||||
* *Arch Linux*: install the [ttf-hack](https://www.archlinux.org/packages/community/any/ttf-hack/) package from the community repository ([otf-hack](https://aur.archlinux.org/packages/otf-hack/) is available in the AUR):
|
||||
|
||||
$ pacman -S ttf-hack
|
||||
|
||||
* *Fedora / CentOS*: install from [copr](https://copr.fedoraproject.org/coprs/heliocastro/hack-fonts/). For Fedora >= 23:
|
||||
|
||||
$ dnf install dnf-plugins-core
|
||||
$ dnf copr enable heliocastro/hack-fonts
|
||||
$ dnf install hack-fonts
|
||||
|
||||
For Fedora <= 22 and CentOS <= 7:
|
||||
|
||||
$ yum install yum-plugin-copr
|
||||
$ yum copr enable heliocastro/hack-fonts
|
||||
|
||||
* *Gentoo Linux*: install the [media-fonts/hack](https://packages.gentoo.org/packages/media-fonts/hack) package from the main Portage tree:
|
||||
|
||||
$ emerge -av media-fonts/hack
|
||||
|
||||
* *Ubuntu / Debian*: install either [fonts-hack-ttf](http://packages.ubuntu.com/xenial/fonts-hack-ttf) or [fonts-hack-otf](http://packages.ubuntu.com/xenial/fonts-hack-otf). Packages are currently available for Ubuntu Xenial or later and the Debian unstable branch:
|
||||
|
||||
$ apt-get install fonts-hack-ttf
|
||||
|
||||
For older systems either manually download and install one of the deb packages or see the [manual install instructions](https://wiki.ubuntu.com/Fonts) and [issue report #189](https://github.com/chrissimpkins/Hack/issues/189).
|
||||
|
||||
For other systems, check for packages using your distro's package manager search function. If no packages exist download your preferred format and copy the font files to either your system font folder (often `/usr/share/fonts/`) or user font folder (often `~/.local/share/fonts/`). On systems using Fontconfig you may need to regenerate the font caches and indexes after copying the files (e.g. `fc-cache -s; mkfontscale <install_path>; mkfontdir <install_path>`).
|
||||
|
||||
|
||||
#### Windows
|
||||
|
||||
As of v2.020, we recommend that users of Windows 7 through Windows 10 use the [Hack Windows installer](https://github.com/source-foundry/Hack-windows-installer/releases/latest) to install the Hack fonts. This tool addresses a number of common Windows font installation issues that have led to a wide range of rendering problems for our users. To view more information about the installer, rationale for its use, the source code, and the VirusTotal report, please see the [Hack Windows Installer repository](https://github.com/source-foundry/Hack-windows-installer).
|
||||
|
||||
If you would prefer to install the files manually, we recommend that you use the [TTF][ttf_latest] fonts. Download the zip archive, extract the files, and double click on the fonts to view them in the font previewer. Click the *Install* button to install them on your system. If you have previously installed the Hack fonts on your system and are having issues with the installation of a newer version, please remove the old Hack fonts before you attempt the new font install. Open `Control Panel`, navigate to `Appearance and Personalization`, then `Fonts`, right click on each of the Hack fonts and delete them. Restart your computer and install the fonts as described above. See [issue report #152](https://github.com/chrissimpkins/Hack/issues/152) and [issue report #177](https://github.com/chrissimpkins/Hack/issues/177) for additional information.
|
||||
|
||||
More information about font installation and upgrade issues on the Windows platform is available on the [Font Installation Issues](https://github.com/source-foundry/Hack-windows-installer/blob/master/FontInstallationIssues.md) document in the Hack Windows Installer repository.
|
||||
|
||||
|
||||
### Webfont Usage
|
||||
|
||||
Hack webfonts are released in eot, ttf, woff, and woff2 formats. They include a complete Hack character set build and a smaller [basic Latin](http://www.unicode.org/charts/PDF/U0000.pdf) + [Latin-1 supplement](http://www.unicode.org/charts/PDF/U0080.pdf) Unicode character block build. The latter build set is smaller in size and is intended to improve page loading times when you do not need the entire Hack character set.
|
||||
|
||||
You can view the rendering of the webfonts at a range of sizes on the [Hack type specimen](http://chrissimpkins.github.io/Hack/font-specimen.html).
|
||||
|
||||
#### Hack by CDN
|
||||
|
||||
Thanks to the generous gang at [jsDelivr](https://github.com/jsdelivr/jsdelivr), you can use a CDN to include Hack on your site with a single stylesheet link in the head of your HTML files. There is no need to download font files from the repository or serve them from your web server.
|
||||
|
||||
Average latency, average uptime, and total downtime data for jsDelivr vs. other popular CDN are available for [http](http://www.cdnperf.com/#jsdelivr,cdnjs,google,yandex,microsoft,jquery,bootstrapcdn/http/30) and [https](http://www.cdnperf.com/#jsdelivr,cdnjs,google,yandex,microsoft,jquery,bootstrapcdn/https/30) protocols.
|
||||
|
||||
Include **one** of the following lines in the `<head>` section of your site's HTML:
|
||||
|
||||
##### Basic Latin + Latin-1 Supplement Character Set
|
||||
|
||||
```html
|
||||
<link rel="stylesheet" href="//cdn.jsdelivr.net/font-hack/2.020/css/hack.min.css">
|
||||
```
|
||||
|
||||
##### Full Character Set
|
||||
|
||||
```html
|
||||
<link rel="stylesheet" href="//cdn.jsdelivr.net/font-hack/2.020/css/hack-extended.min.css">
|
||||
```
|
||||
|
||||
Then style your text by including `Hack` in the appropriate `font-family` property of your CSS. For example:
|
||||
|
||||
```css
|
||||
code {
|
||||
font-family: Hack, monospace;
|
||||
}
|
||||
```
|
||||
|
||||
The **bold**, *italic*, and <b><i>bold italic</i></b> text styles are formatted with HTML using `<b>text block</b>`, `<i>text block</i>`, and `<b><i>text block</i></b>` HTML tags, respectively.
|
||||
|
||||
|
||||
#### Host Hack Font Files on Your Server
|
||||
|
||||
Download the entire web font archive at this link:
|
||||
|
||||
- [Download Web Font Archive (all)](https://github.com/chrissimpkins/Hack/releases/download/v2.020/Hack-v2_020-webfonts.zip)
|
||||
|
||||
Or select the fonts that you need in subdirectories of the build directory:
|
||||
|
||||
- [Download .eot fonts](https://github.com/chrissimpkins/Hack/tree/master/build/webfonts/fonts/eot)
|
||||
- [Download .ttf fonts](https://github.com/chrissimpkins/Hack/tree/master/build/webfonts/fonts/web-ttf) - **Note**: these differ from the desktop versions and are intended for web use
|
||||
- [Download .woff fonts](https://github.com/chrissimpkins/Hack/tree/master/build/webfonts/fonts/woff)
|
||||
- [Download .woff2 fonts](https://github.com/chrissimpkins/Hack/tree/master/build/webfonts/fonts/woff2)
|
||||
|
||||
The web font archive download is structured like this:
|
||||
|
||||
```
|
||||
.
|
||||
├── css
|
||||
│ ├── hack-extended.css
|
||||
│ ├── hack-extended.min.css
|
||||
│ ├── hack.css
|
||||
│ └── hack.min.css
|
||||
└── fonts
|
||||
├── eot
|
||||
│ ├── hack-bold-webfont.eot
|
||||
│ ├── hack-bolditalic-webfont.eot
|
||||
│ ├── hack-regular-webfont.eot
|
||||
│ ├── hack-italic-webfont.eot
|
||||
│ └── latin
|
||||
│ ├── hack-bold-latin-webfont.eot
|
||||
│ ├── hack-bolditalic-latin-webfont.eot
|
||||
│ ├── hack-regular-latin-webfont.eot
|
||||
│ └── hack-italic-latin-webfont.eot
|
||||
├── ttf
|
||||
│ ├── hack-bold-webfont.ttf
|
||||
│ ├── hack-bolditalic-webfont.ttf
|
||||
│ ├── hack-regular-webfont.ttf
|
||||
│ ├── hack-italic-webfont.ttf
|
||||
│ └── latin
|
||||
│ ├── hack-bold-latin-webfont.ttf
|
||||
│ ├── hack-bolditalic-latin-webfont.ttf
|
||||
│ ├── hack-regular-latin-webfont.ttf
|
||||
│ └── hack-italic-latin-webfont.ttf
|
||||
├── woff
|
||||
│ ├── hack-bold-webfont.woff
|
||||
│ ├── hack-bolditalic-webfont.woff
|
||||
│ ├── hack-regular-webfont.woff
|
||||
│ ├── hack-italic-webfont.woff
|
||||
│ └── latin
|
||||
│ ├── hack-bold-latin-webfont.woff
|
||||
│ ├── hack-bolditalic-latin-webfont.woff
|
||||
│ ├── hack-regular-latin-webfont.woff
|
||||
│ └── hack-italic-latin-webfont.woff
|
||||
└── woff2
|
||||
├── hack-bold-webfont.woff2
|
||||
├── hack-bolditalic-webfont.woff2
|
||||
├── hack-regular-webfont.woff2
|
||||
├── hack-italic-webfont.woff2
|
||||
└── latin
|
||||
├── hack-bold-latin-webfont.woff2
|
||||
├── hack-bolditalic-latin-webfont.woff2
|
||||
├── hack-regular-latin-webfont.woff2
|
||||
└── hack-italic-latin-webfont.woff2
|
||||
```
|
||||
|
||||
Push the `css` and `fonts` directories to your web server, then import **one** of the included CSS files in the `head` section of the HTML where you would like to use it.
|
||||
|
||||
Replace `path/to/` with the actual path to your css directory.
|
||||
|
||||
##### Basic Latin + Latin-1 Supplement Character Set
|
||||
|
||||
```html
|
||||
<link rel="stylesheet" href="path/to/css/hack.min.css">
|
||||
```
|
||||
|
||||
|
||||
##### Full Character Set
|
||||
|
||||
```html
|
||||
<link rel="stylesheet" href="path/to/css/hack-extended.min.css">
|
||||
```
|
||||
|
||||
You can alter the path to the Hack files (e.g. place the files in a `hack` resource subdirectory); however, please make sure that you preserve the relative file paths included in the release archive (*or be prepared to modify the paths to the font files*).
|
||||
|
||||
Then style your text by including `Hack` in the appropriate `font-family` property of your CSS. For example:
|
||||
|
||||
```css
|
||||
code {
|
||||
font-family: Hack, monospace;
|
||||
}
|
||||
```
|
||||
|
||||
The **bold**, *oblique*, and <b><i>bold oblique</i></b> text styles are formatted with HTML using `<b>text block</b>`, `<i>text block</i>`, and `<b><i>text block</i></b>` HTML tags, respectively.
|
||||
|
||||
|
||||
##### Webfont Caching and gzip Compression with Cloudflare
|
||||
|
||||
*The following information applies to both paid and free accounts*
|
||||
|
||||
If you use [Cloudflare](https://cloudflare.com), woff files are cached by default. To cache the remaining webfont files, add a new page rule for the path to your fonts directory:
|
||||
|
||||
```
|
||||
yoursite.com/path/to/fonts/
|
||||
```
|
||||
|
||||
and set the rule to `Cache Everything`.
|
||||
|
||||
Cloudflare automates gzip compression of ttf, eot, woff, and svg font files. The service does not gzip compress woff2 files.
|
||||
|
||||
|
||||
### Build Binaries
|
||||
|
||||
#### Desktop Fonts
|
||||
|
||||
##### TTF Builds
|
||||
- `build/ttf/Hack-Regular.ttf`
|
||||
- `build/ttf/Hack-Bold.ttf`
|
||||
- `build/ttf/Hack-Italic.ttf`
|
||||
- `build/ttf/Hack-BoldItalic.ttf`
|
||||
|
||||
##### OTF Builds
|
||||
- `build/otf/Hack-Regular.otf`
|
||||
- `build/otf/Hack-Bold.otf`
|
||||
- `build/otf/Hack-Italic.otf`
|
||||
- `build/otf/Hack-BoldItalic.otf`
|
||||
|
||||
#### Web Fonts
|
||||
|
||||
##### EOT
|
||||
- `build/webfonts/fonts/eot/hack-regular-webfont.eot`
|
||||
- `build/webfonts/fonts/eot/hack-bold-webfont.eot`
|
||||
- `build/webfonts/fonts/eot/hack-italic-webfont.eot`
|
||||
- `build/webfonts/fonts/eot/hack-bolditalic-webfont.eot`
|
||||
- `build/webfonts/fonts/eot/latin/hack-regular-latin-webfont.eot`
|
||||
- `build/webfonts/fonts/eot/latin/hack-bold-latin-webfont.eot`
|
||||
- `build/webfonts/fonts/eot/latin/hack-italic-latin-webfont.eot`
|
||||
- `build/webfonts/fonts/eot/latin/hack-bolditalic-latin-webfont.eot`
|
||||
|
||||
##### Web TTF
|
||||
- `build/webfonts/fonts/web-ttf/hack-regular-webfont.ttf`
|
||||
- `build/webfonts/fonts/web-ttf/hack-bold-webfont.ttf`
|
||||
- `build/webfonts/fonts/web-ttf/hack-italic-webfont.ttf`
|
||||
- `build/webfonts/fonts/web-ttf/hack-bolditalic-webfont.ttf`
|
||||
- `build/webfonts/fonts/web-ttf/latin/hack-regular-latin-webfont.ttf`
|
||||
- `build/webfonts/fonts/web-ttf/latin/hack-bold-latin-webfont.ttf`
|
||||
- `build/webfonts/fonts/web-ttf/latin/hack-italic-latin-webfont.ttf`
|
||||
- `build/webfonts/fonts/web-ttf/latin/hack-bolditalic-latin-webfont.ttf`
|
||||
|
||||
##### WOFF
|
||||
- `build/webfonts/fonts/woff/hack-regular-webfont.woff`
|
||||
- `build/webfonts/fonts/woff/hack-bold-webfont.woff`
|
||||
- `build/webfonts/fonts/woff/hack-italic-webfont.woff`
|
||||
- `build/webfonts/fonts/woff/hack-bolditalic-webfont.woff`
|
||||
- `build/webfonts/fonts/woff/latin/hack-regular-latin-webfont.woff`
|
||||
- `build/webfonts/fonts/woff/latin/hack-bold-latin-webfont.woff`
|
||||
- `build/webfonts/fonts/woff/latin/hack-italic-latin-webfont.woff`
|
||||
- `build/webfonts/fonts/woff/latin/hack-bolditalic-latin-webfont.woff`
|
||||
|
||||
##### WOFF2
|
||||
- `build/webfonts/fonts/woff2/hack-regular-webfont.woff2`
|
||||
- `build/webfonts/fonts/woff2/hack-bold-webfont.woff2`
|
||||
- `build/webfonts/fonts/woff2/hack-italic-webfont.woff2`
|
||||
- `build/webfonts/fonts/woff2/hack-bolditalic-webfont.woff2`
|
||||
- `build/webfonts/fonts/woff2/latin/hack-regular-latin-webfont.woff2`
|
||||
- `build/webfonts/fonts/woff2/latin/hack-bold-latin-webfont.woff2`
|
||||
- `build/webfonts/fonts/woff2/latin/hack-italic-latin-webfont.woff2`
|
||||
- `build/webfonts/fonts/woff2/latin/hack-bolditalic-latin-webfont.woff2`
|
||||
<!-- TODO Webfont Usage -->
|
||||
|
||||
<!-- TODO Build Binaries -->
|
||||
|
||||
### Changes
|
||||
|
||||
Changes are in the [Changelog](https://github.com/chrissimpkins/Hack/blob/master/CHANGELOG.md).
|
||||
|
||||
|
||||
### License
|
||||
|
||||
Hack Copyright 2015-2016, Christopher Simpkins with Reserved Font Name Hack.<br>
|
||||
@ -346,4 +78,3 @@ The full texts of these licenses are available in [LICENSE.md](https://github.co
|
||||
|
||||
[otf_latest]:https://github.com/chrissimpkins/Hack/releases/download/v2.020/Hack-v2_020-otf.zip
|
||||
[ttf_latest]: https://github.com/chrissimpkins/Hack/releases/download/v2.020/Hack-v2_020-ttf.zip
|
||||
|
||||
|
||||
57
docs/BUILD_BINARIES.md
Normal file
57
docs/BUILD_BINARIES.md
Normal file
@ -0,0 +1,57 @@
|
||||
### Build Binaries
|
||||
|
||||
#### Desktop Fonts
|
||||
|
||||
##### TTF Builds
|
||||
- `build/ttf/Hack-Regular.ttf`
|
||||
- `build/ttf/Hack-Bold.ttf`
|
||||
- `build/ttf/Hack-Italic.ttf`
|
||||
- `build/ttf/Hack-BoldItalic.ttf`
|
||||
|
||||
##### OTF Builds
|
||||
- `build/otf/Hack-Regular.otf`
|
||||
- `build/otf/Hack-Bold.otf`
|
||||
- `build/otf/Hack-Italic.otf`
|
||||
- `build/otf/Hack-BoldItalic.otf`
|
||||
|
||||
#### Web Fonts
|
||||
|
||||
##### EOT
|
||||
- `build/webfonts/fonts/eot/hack-regular-webfont.eot`
|
||||
- `build/webfonts/fonts/eot/hack-bold-webfont.eot`
|
||||
- `build/webfonts/fonts/eot/hack-italic-webfont.eot`
|
||||
- `build/webfonts/fonts/eot/hack-bolditalic-webfont.eot`
|
||||
- `build/webfonts/fonts/eot/latin/hack-regular-latin-webfont.eot`
|
||||
- `build/webfonts/fonts/eot/latin/hack-bold-latin-webfont.eot`
|
||||
- `build/webfonts/fonts/eot/latin/hack-italic-latin-webfont.eot`
|
||||
- `build/webfonts/fonts/eot/latin/hack-bolditalic-latin-webfont.eot`
|
||||
|
||||
##### Web TTF
|
||||
- `build/webfonts/fonts/web-ttf/hack-regular-webfont.ttf`
|
||||
- `build/webfonts/fonts/web-ttf/hack-bold-webfont.ttf`
|
||||
- `build/webfonts/fonts/web-ttf/hack-italic-webfont.ttf`
|
||||
- `build/webfonts/fonts/web-ttf/hack-bolditalic-webfont.ttf`
|
||||
- `build/webfonts/fonts/web-ttf/latin/hack-regular-latin-webfont.ttf`
|
||||
- `build/webfonts/fonts/web-ttf/latin/hack-bold-latin-webfont.ttf`
|
||||
- `build/webfonts/fonts/web-ttf/latin/hack-italic-latin-webfont.ttf`
|
||||
- `build/webfonts/fonts/web-ttf/latin/hack-bolditalic-latin-webfont.ttf`
|
||||
|
||||
##### WOFF
|
||||
- `build/webfonts/fonts/woff/hack-regular-webfont.woff`
|
||||
- `build/webfonts/fonts/woff/hack-bold-webfont.woff`
|
||||
- `build/webfonts/fonts/woff/hack-italic-webfont.woff`
|
||||
- `build/webfonts/fonts/woff/hack-bolditalic-webfont.woff`
|
||||
- `build/webfonts/fonts/woff/latin/hack-regular-latin-webfont.woff`
|
||||
- `build/webfonts/fonts/woff/latin/hack-bold-latin-webfont.woff`
|
||||
- `build/webfonts/fonts/woff/latin/hack-italic-latin-webfont.woff`
|
||||
- `build/webfonts/fonts/woff/latin/hack-bolditalic-latin-webfont.woff`
|
||||
|
||||
##### WOFF2
|
||||
- `build/webfonts/fonts/woff2/hack-regular-webfont.woff2`
|
||||
- `build/webfonts/fonts/woff2/hack-bold-webfont.woff2`
|
||||
- `build/webfonts/fonts/woff2/hack-italic-webfont.woff2`
|
||||
- `build/webfonts/fonts/woff2/hack-bolditalic-webfont.woff2`
|
||||
- `build/webfonts/fonts/woff2/latin/hack-regular-latin-webfont.woff2`
|
||||
- `build/webfonts/fonts/woff2/latin/hack-bold-latin-webfont.woff2`
|
||||
- `build/webfonts/fonts/woff2/latin/hack-italic-latin-webfont.woff2`
|
||||
- `build/webfonts/fonts/woff2/latin/hack-bolditalic-latin-webfont.woff2`
|
||||
62
docs/INSTALLATION.md
Normal file
62
docs/INSTALLATION.md
Normal file
@ -0,0 +1,62 @@
|
||||
# Desktop Installation
|
||||
|
||||
Hack is available for download in either [OTF][otf_latest] or [TTF][ttf_latest] formats. The best format and install approach depends on your operating system. If you do not know which format is optimal for your system, the TTF files should be used as your default.
|
||||
|
||||
Because Hack is under active development and updates are released frequently we highly recommended using a package manager or other auto-updating utility. While the package manager releases may be a bit delayed relative to the repository releases, the package managers automate and simplify font updates on your system. Please note that the Hack packages in these package managers are not maintained by the Hack project developers. If you come across a problem with the release schedule in your package manager, please report it directly to the respective package maintainer on your platform.
|
||||
|
||||
## OS X
|
||||
|
||||
The easiest way to install and update Hack on OS X is to use the [Homebrew](http://brew.sh/) package manager. To install the fonts on OS X use the command:
|
||||
|
||||
$ brew cask install caskroom/fonts/font-hack
|
||||
|
||||
|
||||
**OS X Users Please Note**: There has been a change in the Homebrew-Cask system that requires an update of `brew-cask`. If you encounter an error during your Hack install attempt, please execute the following command and then install with the above command again:
|
||||
|
||||
```
|
||||
$ brew uninstall --force brew-cask && brew update
|
||||
```
|
||||
|
||||
Please see [issue report #169](https://github.com/chrissimpkins/Hack/issues/169) for additional details.
|
||||
|
||||
To install the fonts manually you may use either the [OTF][otf_latest] or [TTF][ttf_latest] formats. Download the zip file and extract it. Double clicking each of the font files will open a preview in [Font Book](https://support.apple.com/en-us/HT201749) and the "Install Font" button will copy the font to the correct system location.
|
||||
|
||||
## Linux / BSD
|
||||
|
||||
Most Linux and BSD systems can handle either [TTF][ttf_latest] or [OTF][otf_latest] format fonts. We are aware of package manager support on the following distros:
|
||||
|
||||
* *Arch Linux*: install the [ttf-hack](https://www.archlinux.org/packages/community/any/ttf-hack/) package from the community repository ([otf-hack](https://aur.archlinux.org/packages/otf-hack/) is available in the AUR):
|
||||
|
||||
$ pacman -S ttf-hack
|
||||
|
||||
* *Fedora / CentOS*: install from [copr](https://copr.fedoraproject.org/coprs/heliocastro/hack-fonts/). For Fedora >= 23:
|
||||
|
||||
$ dnf install dnf-plugins-core
|
||||
$ dnf copr enable heliocastro/hack-fonts
|
||||
$ dnf install hack-fonts
|
||||
|
||||
For Fedora <= 22 and CentOS <= 7:
|
||||
|
||||
$ yum install yum-plugin-copr
|
||||
$ yum copr enable heliocastro/hack-fonts
|
||||
|
||||
* *Gentoo Linux*: install the [media-fonts/hack](https://packages.gentoo.org/packages/media-fonts/hack) package from the main Portage tree:
|
||||
|
||||
$ emerge -av media-fonts/hack
|
||||
|
||||
* *Ubuntu / Debian*: install either [fonts-hack-ttf](http://packages.ubuntu.com/xenial/fonts-hack-ttf) or [fonts-hack-otf](http://packages.ubuntu.com/xenial/fonts-hack-otf). Packages are currently available for Ubuntu Xenial or later and the Debian unstable branch:
|
||||
|
||||
$ apt-get install fonts-hack-ttf
|
||||
|
||||
For older systems either manually download and install one of the deb packages or see the [manual install instructions](https://wiki.ubuntu.com/Fonts) and [issue report #189](https://github.com/chrissimpkins/Hack/issues/189).
|
||||
|
||||
For other systems, check for packages using your distro's package manager search function. If no packages exist download your preferred format and copy the font files to either your system font folder (often `/usr/share/fonts/`) or user font folder (often `~/.local/share/fonts/`). On systems using Fontconfig you may need to regenerate the font caches and indexes after copying the files (e.g. `fc-cache -s; mkfontscale <install_path>; mkfontdir <install_path>`).
|
||||
|
||||
|
||||
## Windows
|
||||
|
||||
As of v2.020, we recommend that users of Windows 7 through Windows 10 use the [Hack Windows installer](https://github.com/source-foundry/Hack-windows-installer/releases/latest) to install the Hack fonts. This tool addresses a number of common Windows font installation issues that have led to a wide range of rendering problems for our users. To view more information about the installer, rationale for its use, the source code, and the VirusTotal report, please see the [Hack Windows Installer repository](https://github.com/source-foundry/Hack-windows-installer).
|
||||
|
||||
If you would prefer to install the files manually, we recommend that you use the [TTF][ttf_latest] fonts. Download the zip archive, extract the files, and double click on the fonts to view them in the font previewer. Click the *Install* button to install them on your system. If you have previously installed the Hack fonts on your system and are having issues with the installation of a newer version, please remove the old Hack fonts before you attempt the new font install. Open `Control Panel`, navigate to `Appearance and Personalization`, then `Fonts`, right click on each of the Hack fonts and delete them. Restart your computer and install the fonts as described above. See [issue report #152](https://github.com/chrissimpkins/Hack/issues/152) and [issue report #177](https://github.com/chrissimpkins/Hack/issues/177) for additional information.
|
||||
|
||||
More information about font installation and upgrade issues on the Windows platform is available on the [Font Installation Issues](https://github.com/source-foundry/Hack-windows-installer/blob/master/FontInstallationIssues.md) document in the Hack Windows Installer repository.
|
||||
145
docs/WEBFONT_USAGE.md
Normal file
145
docs/WEBFONT_USAGE.md
Normal file
@ -0,0 +1,145 @@
|
||||
### Webfont Usage
|
||||
|
||||
Hack webfonts are released in eot, ttf, woff, and woff2 formats. They include a complete Hack character set build and a smaller [basic Latin](http://www.unicode.org/charts/PDF/U0000.pdf) + [Latin-1 supplement](http://www.unicode.org/charts/PDF/U0080.pdf) Unicode character block build. The latter build set is smaller in size and is intended to improve page loading times when you do not need the entire Hack character set.
|
||||
|
||||
You can view the rendering of the webfonts at a range of sizes on the [Hack type specimen](http://chrissimpkins.github.io/Hack/font-specimen.html).
|
||||
|
||||
#### Hack by CDN
|
||||
|
||||
Thanks to the generous gang at [jsDelivr](https://github.com/jsdelivr/jsdelivr), you can use a CDN to include Hack on your site with a single stylesheet link in the head of your HTML files. There is no need to download font files from the repository or serve them from your web server.
|
||||
|
||||
Average latency, average uptime, and total downtime data for jsDelivr vs. other popular CDN are available for [http](http://www.cdnperf.com/#jsdelivr,cdnjs,google,yandex,microsoft,jquery,bootstrapcdn/http/30) and [https](http://www.cdnperf.com/#jsdelivr,cdnjs,google,yandex,microsoft,jquery,bootstrapcdn/https/30) protocols.
|
||||
|
||||
Include **one** of the following lines in the `<head>` section of your site's HTML:
|
||||
|
||||
##### Basic Latin + Latin-1 Supplement Character Set
|
||||
|
||||
```html
|
||||
<link rel="stylesheet" href="//cdn.jsdelivr.net/font-hack/2.020/css/hack.min.css">
|
||||
```
|
||||
|
||||
##### Full Character Set
|
||||
|
||||
```html
|
||||
<link rel="stylesheet" href="//cdn.jsdelivr.net/font-hack/2.020/css/hack-extended.min.css">
|
||||
```
|
||||
|
||||
Then style your text by including `Hack` in the appropriate `font-family` property of your CSS. For example:
|
||||
|
||||
```css
|
||||
code {
|
||||
font-family: Hack, monospace;
|
||||
}
|
||||
```
|
||||
|
||||
The **bold**, *italic*, and <b><i>bold italic</i></b> text styles are formatted with HTML using `<b>text block</b>`, `<i>text block</i>`, and `<b><i>text block</i></b>` HTML tags, respectively.
|
||||
|
||||
|
||||
#### Host Hack Font Files on Your Server
|
||||
|
||||
Download the entire web font archive at this link:
|
||||
|
||||
- [Download Web Font Archive (all)](https://github.com/chrissimpkins/Hack/releases/download/v2.020/Hack-v2_020-webfonts.zip)
|
||||
|
||||
Or select the fonts that you need in subdirectories of the build directory:
|
||||
|
||||
- [Download .eot fonts](https://github.com/chrissimpkins/Hack/tree/master/build/webfonts/fonts/eot)
|
||||
- [Download .ttf fonts](https://github.com/chrissimpkins/Hack/tree/master/build/webfonts/fonts/web-ttf) - **Note**: these differ from the desktop versions and are intended for web use
|
||||
- [Download .woff fonts](https://github.com/chrissimpkins/Hack/tree/master/build/webfonts/fonts/woff)
|
||||
- [Download .woff2 fonts](https://github.com/chrissimpkins/Hack/tree/master/build/webfonts/fonts/woff2)
|
||||
|
||||
The web font archive download is structured like this:
|
||||
|
||||
```
|
||||
.
|
||||
├── css
|
||||
│ ├── hack-extended.css
|
||||
│ ├── hack-extended.min.css
|
||||
│ ├── hack.css
|
||||
│ └── hack.min.css
|
||||
└── fonts
|
||||
├── eot
|
||||
│ ├── hack-bold-webfont.eot
|
||||
│ ├── hack-bolditalic-webfont.eot
|
||||
│ ├── hack-regular-webfont.eot
|
||||
│ ├── hack-italic-webfont.eot
|
||||
│ └── latin
|
||||
│ ├── hack-bold-latin-webfont.eot
|
||||
│ ├── hack-bolditalic-latin-webfont.eot
|
||||
│ ├── hack-regular-latin-webfont.eot
|
||||
│ └── hack-italic-latin-webfont.eot
|
||||
├── ttf
|
||||
│ ├── hack-bold-webfont.ttf
|
||||
│ ├── hack-bolditalic-webfont.ttf
|
||||
│ ├── hack-regular-webfont.ttf
|
||||
│ ├── hack-italic-webfont.ttf
|
||||
│ └── latin
|
||||
│ ├── hack-bold-latin-webfont.ttf
|
||||
│ ├── hack-bolditalic-latin-webfont.ttf
|
||||
│ ├── hack-regular-latin-webfont.ttf
|
||||
│ └── hack-italic-latin-webfont.ttf
|
||||
├── woff
|
||||
│ ├── hack-bold-webfont.woff
|
||||
│ ├── hack-bolditalic-webfont.woff
|
||||
│ ├── hack-regular-webfont.woff
|
||||
│ ├── hack-italic-webfont.woff
|
||||
│ └── latin
|
||||
│ ├── hack-bold-latin-webfont.woff
|
||||
│ ├── hack-bolditalic-latin-webfont.woff
|
||||
│ ├── hack-regular-latin-webfont.woff
|
||||
│ └── hack-italic-latin-webfont.woff
|
||||
└── woff2
|
||||
├── hack-bold-webfont.woff2
|
||||
├── hack-bolditalic-webfont.woff2
|
||||
├── hack-regular-webfont.woff2
|
||||
├── hack-italic-webfont.woff2
|
||||
└── latin
|
||||
├── hack-bold-latin-webfont.woff2
|
||||
├── hack-bolditalic-latin-webfont.woff2
|
||||
├── hack-regular-latin-webfont.woff2
|
||||
└── hack-italic-latin-webfont.woff2
|
||||
```
|
||||
|
||||
Push the `css` and `fonts` directories to your web server, then import **one** of the included CSS files in the `head` section of the HTML where you would like to use it.
|
||||
|
||||
Replace `path/to/` with the actual path to your css directory.
|
||||
|
||||
##### Basic Latin + Latin-1 Supplement Character Set
|
||||
|
||||
```html
|
||||
<link rel="stylesheet" href="path/to/css/hack.min.css">
|
||||
```
|
||||
|
||||
|
||||
##### Full Character Set
|
||||
|
||||
```html
|
||||
<link rel="stylesheet" href="path/to/css/hack-extended.min.css">
|
||||
```
|
||||
|
||||
You can alter the path to the Hack files (e.g. place the files in a `hack` resource subdirectory); however, please make sure that you preserve the relative file paths included in the release archive (*or be prepared to modify the paths to the font files*).
|
||||
|
||||
Then style your text by including `Hack` in the appropriate `font-family` property of your CSS. For example:
|
||||
|
||||
```css
|
||||
code {
|
||||
font-family: Hack, monospace;
|
||||
}
|
||||
```
|
||||
|
||||
The **bold**, *oblique*, and <b><i>bold oblique</i></b> text styles are formatted with HTML using `<b>text block</b>`, `<i>text block</i>`, and `<b><i>text block</i></b>` HTML tags, respectively.
|
||||
|
||||
|
||||
##### Webfont Caching and gzip Compression with Cloudflare
|
||||
|
||||
*The following information applies to both paid and free accounts*
|
||||
|
||||
If you use [Cloudflare](https://cloudflare.com), woff files are cached by default. To cache the remaining webfont files, add a new page rule for the path to your fonts directory:
|
||||
|
||||
```
|
||||
yoursite.com/path/to/fonts/
|
||||
```
|
||||
|
||||
and set the rule to `Cache Everything`.
|
||||
|
||||
Cloudflare automates gzip compression of ttf, eot, woff, and svg font files. The service does not gzip compress woff2 files.
|
||||
Loading…
Reference in New Issue
Block a user