Ver código fonte

Add "quick installation" guide

burodepeper 9 anos atrás
pai
commit
cbc96ea95b
1 arquivos alterados com 43 adições e 12 exclusões
  1. 43 12
      README.md

+ 43 - 12
README.md

@@ -1,13 +1,11 @@
 
 # Hack  [![Contributors](https://img.shields.io/badge/contributors-104-orange.svg?style=flat)](https://github.com/chrissimpkins/Hack/blob/master/CONTRIBUTORS.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>
-
 ### a typeface designed for source code
 
-<!-- TODO add links to bitstream vera and dejavu projects -->
+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 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.
+<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>
 
 [Read more](docs/ABOUT.md) about Hack, visit the [project website](http://sourcefoundry.org/hack/) or take a look at a complete [type specimen](http://chrissimpkins.github.io/Hack/font-specimen.html).
 
@@ -17,16 +15,42 @@ The font binaries are released under a license that permits unlimited print, des
 
 ## Quick installation
 
-<!-- TODO quick installation guide -->
+We recommended using the **TrueType** (`.ttf`) version of Hack. An OpenType (`.otf`) build is also available.
+
+#### Mac OS X and Linux
+
+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!
+
+**NOTE**: 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).
 
-### Advanced options (web font usage, package managers, etc.)
+#### Windows
+
+To simplify the installation process on Windows systems, we recommend using 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.
+
+---
+
+## Advanced options
 
 <!-- TODO intro about updates -->
-<!-- TODO links to more details -->
-<!-- TODO add a bit about font-line -->
 
 A full list of all changes can be found in the [CHANGELOG](docs/CHANGELOG.md).
 
+### Advanced installation options
+
+<!-- TODO installation, package managers (intro + link) -->
+
+### Web font usage
+
+<!-- TODO web font usage (intro + link) -->
+
+### Additional tools for customization
+
+<!-- TODO add a bit about font-line -->
+
+
 <!--
 ### New!
 
@@ -39,25 +63,32 @@ or [use one of our handy shell scripts](https://github.com/chrissimpkins/Hack/tr
 
 ---
 
-### Overview
+### Overview of features
 
 - **Typeface Name**: Hack
 - **Category**: Monospaced
 - **Powerline Support**: Yes
-- **Number of glyphs**: 1561
-- **Included glyph sets**: TODO
+- **Number of Glyphs**: 1561
+- **Included Glyph Sets**: TODO
 - **Included Styles**: Regular, Bold, Italic, Bold Italic
-- **Latest release**: v2.020 (2016-04-29)
+- **Latest Release**: v2.020 (2016-04-29)
 
 ---
 
 ### 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_)
+
+<!--
 **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 these licences.