Reworked readme.md, about.md, and installation.md

source-foundry · May 6, 2016 · 38e65e5 · 38e65e5
1 parent 74c631d
commit 38e65e5
Show file tree

Hide file tree

Showing 4 changed files with 51 additions and 50 deletions.
diff --git a/README.md b/README.md
@@ -1,21 +1,25 @@
 
-# Hack  [![Contributors](https://img.shields.io/badge/contributors-104-orange.svg?style=flat)](https://github.com/chrissimpkins/Hack/blob/master/CONTRIBUTORS.md)
+# Hack  [![Contributors](https://img.shields.io/badge/contributors-104-orange.svg?style=flat)](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/) &amp; [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/) &amp; [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 &mdash; 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** &copy; 2015-2016, Christopher Simpkins (with Reserved Font Name _Hack_). 
 
-### License
+**Bitstream Vera Sans Mono** &copy; 2003 Bitstream, Inc. (with Reserved Font Names _Bitstream_ and _Vera_). 
 
-**Hack** &copy; 2015-2016, Christopher Simpkins (with Reserved Font Name _Hack_)<br>
-**Bitstream Vera Sans Mono** &copy; 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** &copy; 2015-2016, Christopher Simpkins with Reserved Font Name Hack.<br>
-Hack Open Font License &amp; Bitstream Vera License
 
-**Bitstream Vera Sans Mono** &copy; 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
diff --git a/docs/ABOUT.md b/docs/ABOUT.md
@@ -1,8 +1,12 @@
-### About
+### About Hack
 
-No frills. No gimmicks.  Hack is hand groomed and optically balanced to be a workhorse face for 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 &amp; DejaVu projects.  
 
-It has deep roots in the libre, open source typeface community and expands upon the contributions of the Bitstream Vera &amp; DejaVu projects.  The face has been re-designed with a larger glyph set, modifications of the original glyph shapes (including distinct point styles and semi-bold punctuation weight in the regular set to make analphabetic characters less transparent), and meticulous attention to metrics (including numerous spacing adjustments to improve the rhythm of the face and the legibility of code at small text sizes).  The large x-height + wide aperture + low contrast design combined with PostScript hinting/hint replacement programs and a TrueType instruction set make it highly legible at commonly used source code text sizes with a sweet spot that runs in the 8px - 12px range on modern desktop and laptop monitors.  Combine it with an HD monitor and you can comfortably work at 6 or 7px sizes. The full set of changes are available in the [changelog](https://github.com/chrissimpkins/Hack/blob/master/CHANGELOG.md).
+<a href="https://sourcefoundry.org/hack/"><img src="../img/hack-specimen-2.png" alt="Hack &mdash; a typeface designed for source code" width="728"></a>
+
+The face has been re-designed with a larger glyph set, modifications of the original glyph shapes (including distinct point styles and semi-bold punctuation weight in the regular set to make analphabetic characters less transparent), and meticulous attention to metrics (including numerous spacing adjustments to improve the rhythm of the face and the legibility of code at small text sizes).
+
+The large x-height + wide aperture + low contrast design combined with PostScript hinting/hint replacement programs and a TrueType instruction set make it highly legible at commonly used source code text sizes with a sweet spot that runs in the 8px - 12px range on modern desktop and laptop monitors.  Combine it with an HD monitor and you can comfortably work at 6 or 7px sizes. The full set of changes are available in the [changelog](https://github.com/chrissimpkins/Hack/blob/master/CHANGELOG.md).
 
 The font binaries are released under a license that permits unlimited print, desktop, and web use for commercial and non-commercial applications.  It may be embedded and distributed in documents and applications.  The source is released in the widely supported UFO format and may be modified to derive new typeface branches.  The full text of the license is available in [LICENSE.md](https://github.com/chrissimpkins/Hack/blob/master/LICENSE.md)
 
@@ -16,6 +20,7 @@ The font binaries are released under a license that permits unlimited print, des
 
 ### Specimen
 
-<a href="http://chrissimpkins.github.io/Hack/font-specimen.html"><img src="img/hack-waterfall.png" alt="Hack font specimen" width="728"></a>
+<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.
diff --git a/CONTRIBUTORS.md → docs/CONTRIBUTORS.md b/CONTRIBUTORS.md → docs/CONTRIBUTORS.md
diff --git a/docs/INSTALLATION.md b/docs/INSTALLATION.md
@@ -57,6 +57,19 @@ For other systems, check for packages using your distro's package manager search
 
 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.
+*Nuget package*: install via [Visual Studio Package Manager Console](https://docs.nuget.org/consume/package-manager-console) ([Package Source](https://www.nuget.org/packages/Hack.Font/2.19.0))
+
+      Install-Package Hack.Font 
+
+*Chocolatey*: install via choco command ([Package Source](https://chocolatey.org/packages/hackfont))
+
+      choco install hackfont
+
+*Manual installation*: If you would prefer to install the files manually, we recommend that you use the *TrueType* (`.ttf`) fonts.  
+
+Download the TTF zip archive from [Releases](https://github.com/chrissimpkins/Hack/releases/latest), 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. 
+
+**NOTE ON UPDATING** 
+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.