diff --git a/CONTRIBUTING.md.orig b/CONTRIBUTING.md.orig deleted file mode 100644 index d5cac7317..000000000 --- a/CONTRIBUTING.md.orig +++ /dev/null @@ -1,115 +0,0 @@ -# Hack Typeface Design - -Hack is a monospaced typeface that is designed to optimize the display of source code text. - -This document outlines the core ideas on which we build to continually improve Hack. Ideally, they serve as a final rationale to decide disputes of whatever nature. - -Design is a highly subjective and opinionated topic. Being a collaborative effort, we prefer to focus on the discussion about a change, rather than the final product of a change. In practical terms this means that for any substantial amount of work, we'd like to see an Issue Report or Pull Request which presents an idea or the approach for a change. By keeping the discussion open, not only will you get community feedback, it also allows us to judge your contribution on more than the final product. - -## Design Targets - -Hack is a general purpose typeface for source code. The _needs of the many_ describe our core design targets. Generally, an issue that affects a majority of users receives higher priority than an issue that affects a minority of users. - -### Core - -- **ASCII glyph set**; generally speaking, all source code is limited to the ASCII set. Content/comments/documentation, on the other hand, often includes non-ASCII characters. The former gets precedence over the latter. -<<<<<<< HEAD -- We focus on an accepted **single glyph style** for each glyph in the typeface sets. Glyph shape changes that are intended to address our design goals take precedence over changes that are purely subjective in nature. -======= -- We focus on an accepted **single glyph style** for each glyph in the typeface sets. Glyph shape changes that are intended to address our design goals take precedence over changes that are purely subjective in nature. We offer the [alt-hack](https://github.com/source-foundry/alt-hack) repository for alternate Hack glyph styles and contributions of alternate styles are welcomed there. ->>>>>>> dev -- Font-sizes between **8-14 px**, line-height >= 1 -- **Cross-platform**, cross font renderer support on Linux, OS X, and Windows operating systems. Changes that address cross platform issues take precedence over issues that address platform specific issues. Changes that improve the typeface on some platforms but decrease its usability on others are generally not acceptable and belong in a fork that is intended for the platforms targeted for these changes. -- Usage in **common source code display scenarios** (on digital displays): text editors, terminals, embedded as web fonts, etc. - -## Goals, areas of improvement - -- **Legibility** - establish differences in the appearance of similar glyph shapes so as to properly identify different Unicode code points -- **Readability** - glyph shape and spacing optimizations to improve the capacity to read character-character, word-word, and code block-code block combinations in source code -- **Visual semantics** - establish semantic commonalities for glyphs used in source code text and create common visual designs within these semantic groups - - -# Issue Reporting - -Issue reports from users are extremely important to foster the ongoing development of the typeface. - -Before you report an issue, please confirm that you have installed the current version of the Hack typeface on your system. See the [README.md page](README.md) for details. - -If you identify a problem, we request that you report it through a new issue report on the Github repository. Please include the following information in your (bug) issue report: - -- Font version (or timeframe when you downloaded the fonts if you do not know) -- Where you obtained the fonts (e.g. repository download, package manager, another source) -- variant(s) of the Hack fonts that are affected (Regular, Bold, Italic, BoldItalic) -- font size at which the problem was observed and whether it occurs at other sizes within the Core design target range (see above) -- operating system and version -- application where the issue was observed and version (important for us to understand the renderer involved) -- screenshot images that visually demonstrate the problem - -Please describe what led to the problem in detail. - - -# Pull Requests - -We highly encourage contributions to the Hack typeface source code, repository scripts, and documentation. To view areas where we currently need your help, check out the active issues [Contribute! label](https://github.com/source-foundry/Hack/labels/Contribute%21). - - -Please read and understand our design philosophy statement above in order to avoid frustration with work that we cannot merge upstream. We are willing to consider pull requests that follow these design guidelines. Having said that, there is never wasted work. If a change is of value to you, it is likely to be of value to others and this is the perfect situation for a downstream fork of Hack that you can maintain and share with other users. - -## Pull requests for design changes - -Contributors who submit source modifications intended for merge into the Hack repository must license these changes according to [LICENSE.md](LICENSE.md). If this is not acceptable, please do not submit your work for consideration. - -Contributors who modify the UFO source code should familiarize themselves with the UFO source specification. The Hack typeface currently uses version 2 of the UFO specification and documentation is available [here](http://unifiedfontobject.org/versions/ufo2/index.html). - -For pull requests that modify the design of the typeface, we request that you limit your source commits to the following changes unless we have discussed and explicitly requested additional file changes as part of the contribution. - - -### Glyph modifications - -<<<<<<< HEAD -- Only include the modified `glyphs/*.glif` source files for the modified glyphs in commits -- Modification of other source files is not acceptable - -### Glyph additions and deletions - -- Include the added and/or deleted `glyphs/*.glif` source file(s) in commits -- Include the `glyphs/contents.plist` source file in commits -- Modification of other source files is not acceptable - - -### Other Issues - -- commits that add or delete UFO source files outside of the above recommendations will not be accepted -======= -Modifications include all existing glyph design changes, glyph additions, and glyph deletions. - -- Only include the modified `glyphs/*.glif` source files for the modified glyphs in your pull request commits -- Modification of other source files is not acceptable and pull requests will not be accepted until the above condition is met - -You can achieve this design modification workflow with one of the following approaches: - -- maintain a separate local directory for your design modifications and copy the `glyphs/*.glif` files that are changed to your local clone of the Hack source, then push to your remote repository fork for your pull request -- modify the Hack source in your local clone of the Hack repository and do not commit file changes other than those that are accepted in pull requests (i.e. only include `*.ufo/glyphs/*.glif` files in your commits) -- modify the Hack source in your local clone of the Hack repository, commit all files, replace all `*plist` files with the upstream versions then perform a git squash commit to eliminate the `*.plist` file changes in the git history (this approach can be used for those who didn't read the instructions and have already commited unacceptable file changes) ->>>>>>> dev - - -## Pull requests for script changes - -Contributors who submit script source modifications intended for merge into the Hack repository must license these changes according to the license specified in the script header for existing files. For new files, please discuss your license with us in an issue report before you submit your work for consideration. - -Please add an issue report that describes the issue that your pull request is intended to address (and that the pull request will close when merged). - -We request that you try not to add additional external dependencies to the project with your commits. This has the potential to prevent releases of Hack packages on some platforms. If you need to add a new dependency to the project, we suggest that you discuss this with us in advance through an issue report so that we can confirm that this is acceptable. - -## Pull requests for documentation changes - -We love help with our docs! This includes anything from simple misspelling or grammar changes to major revisions of poorly written sections. For minor changes, a simple pull request suffices. For major edits, we recommend that you discuss the changes with us in an issue report before you go to the effort. - -# Contributors - -<<<<<<< HEAD -Contributions to the project come in many forms and we **want** to broadly acknowledge those who spend time and effort to improve the project. We understand that many contributions to open source projects are not in the form of changes to the code base and therefore not automatically recognized in the Github repository UI. We maintain a [CONTRIBUTORS.md](docs/CONTRIBUTORS.md) list to acknowledge project contributors for this reason. If you feel that you have helped to improve Hack and your contributions have been overlooked (i.e. you are not included on the contributors list), please let us know so that we can rectify this issue! In all likelihood this is an oversight and not intended to be a slight. -======= -Contributions to the project come in many forms and we **want** to broadly acknowledge those who spend time and effort to improve the project. We understand that many contributions to open source projects are not in the form of changes to the code base and therefore not automatically recognized in the Github repository UI. Use case specialists play an extremely important role in the improvement of this typeface. Individuals who have knowledge of the intricacies of open source typeface licensing, understand open source project redistribution processes, have the capacity to view errors and test in unique platform x font renderer situations, and many other areas that extend beyond the "source code commit" criterion have contributed their expertise to improve Hack. Understanding this issue, we maintain a [CONTRIBUTORS.md](docs/CONTRIBUTORS.md) list to acknowledge project contributors for their time and efforts under our own defintion of a project contribution. If you feel that you have helped to improve Hack and your contributions have been overlooked (i.e. you are not included on the contributors list), please let us know so that we can rectify this issue! In all likelihood this is an oversight and not intended to be a slight. ->>>>>>> dev diff --git a/README.md.orig b/README.md.orig deleted file mode 100644 index 8910fd2e5..000000000 --- a/README.md.orig +++ /dev/null @@ -1,197 +0,0 @@ - -# Hack - -[![Build Status](https://travis-ci.org/source-foundry/Hack.svg?branch=master)](https://travis-ci.org/source-foundry/Hack) [![Contributors](https://img.shields.io/badge/contributors-121-orange.svg?style=flat)](https://github.com/source-foundry/Hack/blob/master/docs/CONTRIBUTORS.md) - -### A typeface designed for source code - -Hack is designed to be a workhorse typeface for source code. It has deep roots in the free, 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. The large x-height + wide aperture + low contrast design make it legible at commonly used source code text sizes with a sweet spot that runs in the 8px - 14px range. The full set of changes to the upstream source are available in the [changelog](CHANGELOG.md). - -The project is in active development and we welcome your input and contributions. You may view our design objectives and contributing instructions in [CONTRIBUTING.md](CONTRIBUTING.md). - -Frequently asked questions are answered in our [FAQ](FAQ.md). - -### Contents - -* [Features](#overview-of-features) -* [Quick installation](#quick-installation) -* [Package manager installation](#package-managers) -* [Web font usage](#web-font-usage) -* [Additional tools for font customization](#additional-tools-for-hack-font-customization) -* [Resources](#resources) -* [Contributing](#contributing) -* [Build tools](#built-with) -* [Acknowledgments](#acknowledgments) -* [License](#license) - - -### Specimen - -Hack — a typeface designed for source code - -## Overview of features - -- **Typeface Name**: Hack -- **Category**: Monospaced -- **Character set support**: ASCII, Latin-1, Latin Extended A, Greek, Cyrillic -- **Powerline Support**: Yes, included by default -- **Included Styles**: Regular, Bold, Italic, Bold Italic - -## Quick installation - -**NOTE ON FONT UPDATES** -*If you are updating your version of Hack, be sure to remove the previously installed version and clear your font cache first to avoid conflicts that can lead to platform-specific rendering errors. Many platforms/distros offer package managers that automate this process. We release a Windows installer to automate the install/update process on the Windows platform. See below for additional details.* - -### Linux - -1. Download the [latest version of Hack](ttf_latest) -2. Extract the files from the archive (`.zip`) -3. Copy the font files to either your system font folder (often `/usr/share/fonts/`) or user font folder (often `~/.local/share/fonts/`) -4. Clear and regenerate your font cache and indexes with the following set of commands: - -``` -$ fc-cache -$ mkfontscale -$ mkfontdir -``` - -### Mac OS X - -1. Download the [latest version of Hack][ttf_latest]. -2. Extract the files from the archive (`.zip`) and click to 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) which will guide you through the installation process. This installer addresses a number of common rendering issues that occur with font installs/updates on the Windows platform and is the recommended approach for Windows users. - - -### Chrome/ChromeOS - -To use with [Secure Shell](https://chrome.google.com/webstore/detail/secure-shell/pnhechapfaindjhompbnflcldabbghjo), -edit the following fields in Options: - - - font-family: `"Hack"` - - user-css: `https://cdn.jsdelivr.net/font-hack/2.020/css/hack-extended.min.css` - -## Package managers - -We highly recommend the convenience of a community developed 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 packages distributed through these package managers were designed to tune and automate font installs and updates on your system. - -We are aware of Hack support in the following package managers (with associated package names): - -- **Arch Linux**: `ttf-hack` -- **Chocolatey (Windows)**: `hackfont` -- **Debian**: `fonts-hack-ttf` -- **Fedora / CentOS**: `dnf-plugins-core :: heliocastro/hack-fonts :: hack-fonts` -- **Gentoo Linux**: `media-fonts/hack` -- **Homebrew Cask (OS X)**: `caskroom/fonts/font-hack` -- **OpenSUSE**: `hack-fonts` -- **Ubuntu**: `fonts-hack-ttf` -- **Visual Studio Package Manager**: `hack.font` - -For installation issues with Hack packages, please contact the package maintainer directly. - - -## Web font usage - -Hack is available in the woff and woff2 web font formats. Use the snippets below to quickly include Hack via a CDN. **Bold** and *italic* styles are included by default and work out-of-the-box via the `` and `` tags. - -#### 1. Add Hack to HTML - -Include one of the following in the <head> section of your HTML file: - -**Subset web fonts** - -```html - -``` - -**Full character set web fonts** - -```html - -``` - -#### 2. Add Hack to CSS - - -```css -pre, code { font-family: Hack, monospace; } -``` - -See the [WEBFONT_USAGE.md](docs/WEBFONT_USAGE.md) documentation for additional details, including instructions on how to download, host, and serve the web fonts on your own web server. - -## Additional tools for Hack font customization - -### Customize your build with alternate glyph styles - -The [alt-hack](https://github.com/source-foundry/alt-hack) library includes a (growing) collection of alternate glyph styles that can be used to customize your Hack fonts. Don't like the default zero style? Swap out the UFO design source with a slashed zero or dotted zero and build new fonts that work better for you. - -Contributions of new glyph styles are welcomed in the alt-hack repository. Design something new that works well with rest of the typeface and submit a pull request to the alt-hack repository so that others can use it in their own custom builds. - -Detailed build instructions are available on the [alt-hack repository README.md](https://github.com/source-foundry/alt-hack). - -### Line spacing adjustments - -[font-line](https://github.com/source-foundry/font-line) is a tool that lets you easily modify the default line spacing that is used in the Hack design (20% UPM). - -The following gist installs font-line and modifies line spacing for all ttf and otf fonts in the working directory where the script is located for the percent UPM value that you define at the top of the script: - -- [linespace.sh](https://gist.github.com/chrissimpkins/f39e85f5f157d839e46168de1b61a174) ([download .zip](https://gist.github.com/chrissimpkins/f39e85f5f157d839e46168de1b61a174/archive/f3f93dea87d64ddc4684a61cbc96ddf79d30824a.zip)) - - -## Resources -<<<<<<< HEAD -* [About Hack](docs/ABOUT.md) -======= ->>>>>>> dev -* [Full specimen](http://source-foundry.github.io/Hack/font-specimen.html) -* [Changelog](CHANGELOG.md) -* [Project website](http://sourcefoundry.org/hack/) -* [Contributors](docs/CONTRIBUTORS.md) - - -## Contributing - -Contributions to the Hack project are welcomed. Please review our [CONTRIBUTING.md](CONTRIBUTING.md) document for details. - - -## Built With - -Hack is built with the following free, open source tools: - -- [Font Bakery](https://github.com/googlefonts/fontbakery) - post-compilation modifications -- [fontmake](https://github.com/googlei18n/fontmake) - UFO to ttf compilation -- [font-v](https://github.com/source-foundry/font-v) - font versioning, git commit sha1 short string labeling of font versions -- [sfnt2woff_zopfli](https://github.com/bramstein/sfnt2woff-zopfli) - ttf to woff web font compilation -- [ttfautohint](https://www.freetype.org/ttfautohint/) - ttf instruction sets -- [ufodiff](https://github.com/source-foundry/ufodiff) - UFO source diffs -- [ufoLib](https://github.com/unified-font-object/ufoLib) - UFO source file reads/writes/testing -- [ufolint](https://github.com/source-foundry/ufolint) - UFO source file linting for CI testing -- [woff2](https://github.com/google/woff2) - ttf to woff2 web font compilation - - -## Acknowledgments - -We would like to acknowledge and thank the [jsDelivr](https://www.jsdelivr.com/) team for their excellent web font CDN service and outstanding Hack project support. - - -## License - -**Hack** work is © 2017 Source Foundry Authors. MIT License - -**Bitstream Vera Sans Mono** © 2003 Bitstream, Inc. (with Reserved Font Names _Bitstream_ and _Vera_). Bitstream Vera License. - -The font binaries are released under a license that permits unlimited print, desktop, web, and software embedding use for commercial and non-commercial applications. - -See [LICENSE.md](https://github.com/source-foundry/Hack/blob/master/LICENSE.md) for the full texts of the licenses. - - - - - -[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 deleted file mode 100644 index 125d911f0..000000000 --- a/docs/ABOUT.md +++ /dev/null @@ -1,19 +0,0 @@ -### About Hack - -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 & DejaVu projects. - -Hack — a typeface designed for source code - -The face has been re-designed with glyph set expansions, 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. 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) - - -### Specimen - -Hack font specimen - - -Click the image for the full type specimen.