From 4a4f63ddc3257bc46a13b4cd1d0d447d0dada94f Mon Sep 17 00:00:00 2001 From: Chris Simpkins Date: Mon, 25 Apr 2016 22:47:37 -0400 Subject: [PATCH 1/3] expanded installer documentation --- README.md | 42 ++++++++++++++++++++++++++++-------------- 1 file changed, 28 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 296d18f..ae89b54 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,21 @@ -# Hack Windows Installer +# Hack Font Installer for Windows A Windows installer for the [Hack](https://github.com/chrissimpkins/Hack) typeface. -## Usage -- Download from [Releases](https://github.com/source-foundry/Hack-windows-installer/releases/) -- Run HackWindowsInstaller.exe -- Follow the instructions +## Why is a Windows Font Installer Necessary? + +While it might seem like overkill to use a Windows installer for fonts, there is good reason for this on the Windows platform. A number of things can go wrong when one tries to install or update frequently updated fonts manually (see [issue #152](https://github.com/chrissimpkins/Hack/issues/152) in the Hack repository). -## Why this project exists +This installer addresses most of these issues. A (not complete) list of things that can go wrong can be found in [FontInstallationIssues.md](https://github.com/source-foundry/Hack-windows-installer/blob/master/FontInstallationIssues.md). -It might seem to be overkill to have an installation tool just for some fonts, but a lot of things can go wrong when trying to install or update them manually (see [issue #152](https://github.com/chrissimpkins/Hack/issues/152) in the Hack repository). -The installer can prevent most of these issues. A (not complete) list of things that can go wrong can be found in [FontInstallationIssues.md](https://github.com/source-foundry/Hack-windows-installer/blob/master/FontInstallationIssues.md). +## Usage + +- Download HackWindowsInstaller.exe from [Releases](https://github.com/source-foundry/Hack-windows-installer/releases/latest) +- Double click HackWindowsInstaller.exe +- Follow the installation instructions + ## Silent Installation @@ -20,25 +23,36 @@ To install silently, use the following command: ``start /wait HackWindowsInstaller.exe /VERYSILENT /SUPPRESSMSGBOXES /NORESTART /CLOSEAPPLICATIONS /NORESTARTAPPLICATIONS`` -To remove it silently: +To remove it silently: ``C:\Program Files\Hack Windows Installer\unins000.exe /VERYSILENT /SUPPRESSMSGBOXES /NORESTART`` + +## Installer Source + +You may review the comment annotated installer source in [HackWindowsInstaller.iss](https://github.com/source-foundry/Hack-windows-installer/blob/master/src/HackWindowsInstaller.iss). + +We release the compiled installer with its SHA256 hash digest and [VirusTotal](https://virustotal.com/en/) malware scan report link in [Releases](https://github.com/source-foundry/Hack-windows-installer/releases). + + ## Troubleshooting -The installer always creates a log file as C:\Users\ (Username) \AppData\Local\Temp\Setup Log (Year-Month-Day) #.txt. +The installer creates a log file on the path C:\Users\ (Username) \AppData\Local\Temp\Setup Log (Year-Month-Day) #.txt. If you are using EMET: If the "Only trusted fonts" option is activated, you need to declare Hack as trusted or it will not be usable. + ## Contributions Any constructive contribution is very welcome! If you have any question or encounter a bug, please create a new [issue](https://github.com/source-foundry/Hack-windows-installer/issues/new). -## Build from source -To build this setup yourself, download the newest ANSI (not unicode) version of [Inno Setup](http://www.jrsoftware.org/isdl.php). Install it and activate the option to install the [Inno Setup Preprocessor](http://www.jrsoftware.org/ispphelp/). +## Build from Source + +To build this setup yourself, download the most recent ANSI (not Unicode) version of [Inno Setup](http://www.jrsoftware.org/isdl.php). Install it and activate the option to install the [Inno Setup Preprocessor](http://www.jrsoftware.org/ispphelp/). + +Double-click `HackWindowsInstall.iss` (from folder `src`), which will load it in Inno Setup and then select *Build* - *Compile*. -Double-click `HackWindowsInstall.iss` (from folder `src`), which will load it in Inno Setup and then select *Build* - *Compile*. -## About +## License Copyright © 2016 [Michael Hex](http://www.texhex.info/) / Source Foundry. Licensed under the **MIT License**. For details, please see [LICENSE.txt](https://github.com/source-foundry/Hack-windows-installer/blob/master/LICENSE.txt). From d8f32ef37c02f200c2fee356ca53579c211cd9c8 Mon Sep 17 00:00:00 2001 From: Chris Simpkins Date: Mon, 25 Apr 2016 22:50:00 -0400 Subject: [PATCH 2/3] reverted title change back to repo name --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index ae89b54..378ba0c 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Hack Font Installer for Windows +# Hack Windows Installer A Windows installer for the [Hack](https://github.com/chrissimpkins/Hack) typeface. From 5bdfb953c2b04502ed71390cab0f1f098575d4d3 Mon Sep 17 00:00:00 2001 From: Chris Simpkins Date: Mon, 25 Apr 2016 22:52:09 -0400 Subject: [PATCH 3/3] minor formatting changes --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 378ba0c..fde383b 100644 --- a/README.md +++ b/README.md @@ -12,8 +12,8 @@ This installer addresses most of these issues. A (not complete) list of things t ## Usage -- Download HackWindowsInstaller.exe from [Releases](https://github.com/source-foundry/Hack-windows-installer/releases/latest) -- Double click HackWindowsInstaller.exe +- Download `HackWindowsInstaller.exe` from [Releases](https://github.com/source-foundry/Hack-windows-installer/releases/latest) +- Double click `HackWindowsInstaller.exe` - Follow the installation instructions