Skip to content

Commit 8684927

Browse files
committed
Merge pull request #5 from chrissimpkins/master
expansion of readme documentation
2 parents 3b3320e + 5bdfb95 commit 8684927

File tree

1 file changed

+27
-13
lines changed

1 file changed

+27
-13
lines changed

README.md

Lines changed: 27 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,43 +2,57 @@
22

33
A Windows installer for the [Hack](https://github.com/chrissimpkins/Hack) typeface.
44

5-
## Usage
65

7-
- Download from [Releases](https://github.com/source-foundry/Hack-windows-installer/releases/)
8-
- Run HackWindowsInstaller.exe
9-
- Follow the instructions
6+
## Why is a Windows Font Installer Necessary?
7+
8+
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).
109

11-
## Why this project exists
10+
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).
1211

13-
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).
1412

15-
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).
13+
## Usage
14+
15+
- Download `HackWindowsInstaller.exe` from [Releases](https://github.com/source-foundry/Hack-windows-installer/releases/latest)
16+
- Double click `HackWindowsInstaller.exe`
17+
- Follow the installation instructions
18+
1619

1720
## Silent Installation
1821

1922
To install silently, use the following command:
2023

2124
``start /wait HackWindowsInstaller.exe /VERYSILENT /SUPPRESSMSGBOXES /NORESTART /CLOSEAPPLICATIONS /NORESTARTAPPLICATIONS``
2225

23-
To remove it silently:
26+
To remove it silently:
2427

2528
``C:\Program Files\Hack Windows Installer\unins000.exe /VERYSILENT /SUPPRESSMSGBOXES /NORESTART``
2629

30+
31+
## Installer Source
32+
33+
You may review the comment annotated installer source in [HackWindowsInstaller.iss](https://github.com/source-foundry/Hack-windows-installer/blob/master/src/HackWindowsInstaller.iss).
34+
35+
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).
36+
37+
2738
## Troubleshooting
2839

29-
The installer always creates a log file as C:\Users\ (Username) \AppData\Local\Temp\Setup Log (Year-Month-Day) #<XXX>.txt.
40+
The installer creates a log file on the path C:\Users\ (Username) \AppData\Local\Temp\Setup Log (Year-Month-Day) #<XXX>.txt.
3041

3142
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.
3243

44+
3345
## Contributions
3446

3547
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).
3648

37-
## Build from source
3849

39-
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/).
50+
## Build from Source
51+
52+
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/).
53+
54+
Double-click `HackWindowsInstall.iss` (from folder `src`), which will load it in Inno Setup and then select *Build* - *Compile*.
4055

41-
Double-click `HackWindowsInstall.iss` (from folder `src`), which will load it in Inno Setup and then select *Build* - *Compile*.
4256

43-
## About
57+
## License
4458
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).

0 commit comments

Comments
 (0)