|
|
@@ -1,21 +1,25 @@
|
|
|
|
|
|
-# Hack [](https://github.com/chrissimpkins/Hack/blob/master/CONTRIBUTORS.md)
|
|
|
+# Hack [](https://github.com/chrissimpkins/Hack/blob/master/docs/CONTRIBUTORS.md)
|
|
|
|
|
|
### a typeface designed for source code
|
|
|
|
|
|
-No frills. No gimmicks. Hack is hand groomed and optically balanced to be a workhorse face for code. It has deep roots in the libre, open source typeface community and expands upon the contributions of the [Bitstream Vera](https://www.gnome.org/fonts/) & [DejaVu](http://dejavu-fonts.org/wiki/Main_Page) projects.
|
|
|
+No frills. No gimmicks. Hack is hand groomed by Christopher Simpkins and optically balanced to be a workhorse face for code. It has deep roots in the libre, open source typeface community and expands upon the contributions of the [Bitstream Vera](https://www.gnome.org/fonts/) & [DejaVu](http://dejavu-fonts.org/wiki/Main_Page) projects.
|
|
|
|
|
|
-[Read more](docs/ABOUT.md) about Hack, visit the [project website](http://sourcefoundry.org/hack/), take a look at a complete [type specimen](http://chrissimpkins.github.io/Hack/font-specimen.html) or browse the [CHANGELOG](CHANGELOG.md).
|
|
|
+* [Quick installation](#user-content-quick-installation)
|
|
|
+* [About Hack](docs/ABOUT.md)
|
|
|
+* [Type specimen](http://chrissimpkins.github.io/Hack/font-specimen.html)
|
|
|
+* [Project website](http://sourcefoundry.org/hack/)
|
|
|
+* [Changelog](CHANGELOG.md)
|
|
|
+* [Contributors](docs/CONTRIBUTORS.md)
|
|
|
+* [License](#user-content-license)
|
|
|
|
|
|
The font binaries are released under a license that permits unlimited print, desktop, and web use for commercial and non-commercial applications. More details in [LICENSE.md](LICENSE.md)
|
|
|
|
|
|
-<a href="https://sourcefoundry.org/hack/"><img src="img/hack-specimen-2.png" alt="Hack — a typeface designed for source code" width="728"></a>
|
|
|
-
|
|
|
----
|
|
|
-
|
|
|
## Quick installation
|
|
|
|
|
|
-We recommend use of the **TrueType** (`.ttf`) version of Hack for most users.
|
|
|
+#### Windows
|
|
|
+
|
|
|
+To simplify the installation process on Windows systems, we've created the [Hack Windows Installer](https://github.com/source-foundry/Hack-windows-installer/releases/latest) (`.exe`) which will guide you through the installation process. This installer addresses a number of common rendering issues that occur with font installs on the Windows platform and is the recommended approach on the Windows platform.
|
|
|
|
|
|
#### Mac OS X and Linux
|
|
|
|
|
|
@@ -24,36 +28,31 @@ We recommend use of the **TrueType** (`.ttf`) version of Hack for most users.
|
|
|
3. Follow the instructions from your operating system.
|
|
|
4. Enjoy!
|
|
|
|
|
|
-#### Windows
|
|
|
-
|
|
|
-To simplify the installation process on Windows systems, we've created the [Hack Windows Installer](https://github.com/source-foundry/Hack-windows-installer/releases/latest) (`.exe`) which will guide you through the installation process. This installer addresses a number of common rendering issues that occur with font installs on the Windows platform and is the recommended approach on the Windows platform.
|
|
|
+**NOTE ON UPDATING**
|
|
|
+If you are updating your version of Hack, be sure to remove the previously installed version first to avoid conflicts.
|
|
|
|
|
|
-**NOTE ON UPDATING**<br>
|
|
|
-If you are updating your version of Hack, be sure to remove the previously installed version first to avoid conflicts. For more information, see [INSTALLATION.md](docs/INSTALLATION.md).
|
|
|
+#### Manual installation
|
|
|
|
|
|
-A [build with CFF curves][otf_latest] (`.otf`) is available for those who prefer this format.
|
|
|
+We recommend use of the [TrueType](ttf_latest) (`.ttf`) version of Hack for most users. A [build with CFF curves][otf_latest] (`.otf`) is available for those who prefer this format. For detailed installation instructions, see [INSTALLATION.md](docs/INSTALLATION.md).
|
|
|
|
|
|
----
|
|
|
|
|
|
-## Advanced options
|
|
|
+## Package managers
|
|
|
|
|
|
Because Hack is under active development and updates are released frequently, we highly recommended the convenience of a package manager or other auto-updating utility if this is available on your platform. 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.
|
|
|
|
|
|
-### Package managers and desktop installation
|
|
|
-
|
|
|
-Details on using package managers and/or advanced manual desktop installation options can be found in [INSTALLATION.md](docs/INSTALLATION.md).
|
|
|
-
|
|
|
-Hack can be installed and updated via various package managers. We are aware of package manager support on the following systems/distros:
|
|
|
-
|
|
|
- **Mac OS X**: `brew cask install caskroom/fonts/font-hack`
|
|
|
- **Arch Linux**: `pacman -S ttf-hack`
|
|
|
- **Fedora / CentOS**: `copr`, `dnf` or `yum`
|
|
|
- **Gentoo Linux**: `emerge -av media-fonts/hack`
|
|
|
- **Ubuntu / Debian**: `apt-get install fonts-hack-ttf`
|
|
|
+- **Visual Studio (Package Manager)**: `install-package hack.font`
|
|
|
+- **Chocolatey**: `choco install hackfont`
|
|
|
+
|
|
|
+Details on using package managers and/or advanced manual desktop installation options can be found in [INSTALLATION.md](docs/INSTALLATION.md).
|
|
|
|
|
|
<!-- TODO @david: the Fedora/CentOS are a set of multiline commands, how best to display these (see original README). Users will need all of the info contained previously -->
|
|
|
|
|
|
-### Web font usage
|
|
|
+## Web font usage
|
|
|
|
|
|
Hack is available in all commonly used web font formats. See [WEBFONT_USAGE.md](docs/WEBFONT_USAGE.md) for more details, or use the snippets below to quickly include Hack via a CDN (thanks to the generous gang at [jsDelivr](https://github.com/jsdelivr/jsdelivr)). **Bold** and _italic_ styles are included by default and work out-of-the-box via the `<strong>` and `<em>` tags.
|
|
|
|
|
|
@@ -68,38 +67,22 @@ Hack is available in all commonly used web font formats. See [WEBFONT_USAGE.md](
|
|
|
code { font-family: Hack, monospace; }
|
|
|
```
|
|
|
|
|
|
-### Additional tools for customization
|
|
|
+#### Additional tools for customization
|
|
|
|
|
|
**font-line** is a tool that lets you easily modify the default line spacing of Hack (20% UPM). See the [font-line repository](https://github.com/source-foundry/font-line) for more details, and be sure to check out the [line-spacing directory of the repository](https://github.com/chrissimpkins/Hack/tree/master/tools/line-spacing) for shell scripts that automate the entire process across several commonly used line spacing defaults.
|
|
|
|
|
|
----
|
|
|
-
|
|
|
-## Overview of features
|
|
|
|
|
|
-- **Typeface Name**: Hack
|
|
|
-- **Category**: Monospaced
|
|
|
-- **Powerline Support**: Yes
|
|
|
-- **Number of Glyphs**: 1561
|
|
|
-- **Included Glyph Sets**: ASCII, etc. **TODO**
|
|
|
-- **Included Styles**: Regular, Bold, Italic, Bold Italic
|
|
|
-- **Latest Release**: v2.020 (2016-04-29)
|
|
|
+## License
|
|
|
|
|
|
----
|
|
|
+**Hack** © 2015-2016, Christopher Simpkins (with Reserved Font Name _Hack_).
|
|
|
|
|
|
-### License
|
|
|
+**Bitstream Vera Sans Mono** © 2003 Bitstream, Inc. (with Reserved Font Names _Bitstream_ and _Vera_).
|
|
|
|
|
|
-**Hack** © 2015-2016, Christopher Simpkins (with Reserved Font Name _Hack_)<br>
|
|
|
-**Bitstream Vera Sans Mono** © 2003 Bitstream, Inc. (with Reserved Font Names _Bitstream_ and _Vera_)
|
|
|
+See [LICENSE.md](https://github.com/chrissimpkins/Hack/blob/master/LICENSE.md) for the full texts of the licenses.
|
|
|
|
|
|
-<!--
|
|
|
-**Hack** © 2015-2016, Christopher Simpkins with Reserved Font Name Hack.<br>
|
|
|
-Hack Open Font License & Bitstream Vera License
|
|
|
|
|
|
-**Bitstream Vera Sans Mono** © 2003 Bitstream, Inc. with Reserved Font Names Bitstream and Vera<br>
|
|
|
-Bitstream Vera License
|
|
|
--->
|
|
|
|
|
|
-See [LICENSE.md](https://github.com/chrissimpkins/Hack/blob/master/LICENSE.md) for the full texts of the licenses.
|
|
|
+<!-- THE FOLLOWING LINKS ARE ALSO USED IN INSTALLATION.MD -->
|
|
|
|
|
|
[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
|
Michael Hex