Bladeren bron

link updates, minor text changes, minor formatting changes

Chris Simpkins 9 jaren geleden
bovenliggende
commit
74c631d18d
1 gewijzigde bestanden met toevoegingen van 20 en 17 verwijderingen
  1. 20 17
      README.md

+ 20 - 17
README.md

@@ -5,7 +5,7 @@
 
 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.
 
-[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 marvel at the [CHANGELOG](CHANGELOG.md).
+[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).
 
 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)
 
@@ -15,27 +15,29 @@ The font binaries are released under a license that permits unlimited print, des
 
 ## Quick installation
 
-We recommended using the **TrueType** (`.ttf`) version of Hack. An OpenType (`.otf`) build is available for experienced users.
+We recommend use of the **TrueType** (`.ttf`) version of Hack for most users.
 
 #### Mac OS X and Linux
 
-1. Download the [latest version of Hack](ttf_latest).
+1. Download the [latest version of Hack][ttf_latest].
 2. Extract the files from the archive (`.zip`) and open them.
 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**<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).
 
-#### 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/tag/v1.1.2) (`.exe`) which will guide you through the installation process. The installer will also clean up any previous installation of Hack.
+A [build with CFF curves][otf_latest] (`.otf`) is available for those who prefer this format.
 
 ---
 
 ## Advanced options
 
-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.
+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
 
@@ -43,21 +45,24 @@ Details on using package managers and/or advanced manual desktop installation op
 
 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**: `homebrew`
-- **Arch Linux**: `pacman`
+- **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`
-- **Ubuntu / Debian**: `apt-get`
+- **Gentoo Linux**: `emerge -av media-fonts/hack`
+- **Ubuntu / Debian**: `apt-get install fonts-hack-ttf`
 
-<!-- TODO @chris: no idea if the wording of the above makes any sense for package manager users -->
+<!-- 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
 
-Hack is available in all the regular webfont 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.
+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.
+
+**&lt;head&gt; Section of HTML file**
 
 ```html
 <link rel="stylesheet" href="//cdn.jsdelivr.net/font-hack/2.020/css/hack.min.css">
 ```
+**CSS file**
 
 ```css
 code { font-family: Hack, monospace; }
@@ -65,7 +70,7 @@ code { font-family: Hack, monospace; }
 
 ### Additional tools for customization
 
-**font-line** is a tool that lets you easily modify the default line spacing of Hack. See the [font-line repository](https://github.com/source-foundry/font-line) for more details, and be sure to check out the [line-spacing repository](https://github.com/chrissimpkins/Hack/tree/master/tools/line-spacing) for some font-line automation.
+**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.
 
 ---
 
@@ -83,8 +88,6 @@ code { font-family: Hack, monospace; }
 
 ### License
 
-<!-- TODO Are the two lines with the names of the licences required (since they are also in LICENSE.md)? -->
-
 **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_)
 
@@ -96,7 +99,7 @@ Hack Open Font License &amp; Bitstream Vera License
 Bitstream Vera License
 -->
 
-See [LICENSE.md](https://github.com/chrissimpkins/Hack/blob/master/LICENSE.md) for the full texts of these licences.
+See [LICENSE.md](https://github.com/chrissimpkins/Hack/blob/master/LICENSE.md) for the full texts of the licenses.
 
 [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