Cleanup of readme.md and installation script

Author: texhex

README.md

@@ -2,12 +2,9 @@
 
 A Windows installer for the [Hack](https://github.com/chrissimpkins/Hack) typeface.
 
+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) and [issue #129](https://github.com/chrissimpkins/Hack/issues/129) in the [Hack repository](https://github.com/chrissimpkins/Hack/)). 
 
-## 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).
-
-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).
+This installer addresses most of the [commonly obeserved issues](https://github.com/source-foundry/Hack-windows-installer/blob/master/FontInstallationIssues.md).
 
 
 ## Usage
@@ -17,6 +14,15 @@ This installer addresses most of these issues. A (not complete) list of things t
 - Follow the installation instructions
 
 
+## 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).
+
+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` (folder `src`), which will load it in Inno Setup and select *Build* - *Compile*.
+
+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/latest).
+
+
 ## Silent Installation
 
 To install silently, use the following command:
@@ -28,30 +34,25 @@ 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 creates a log file on the path C:\Users\ (Username) \AppData\Local\Temp\Setup Log (Year-Month-Day) #<XXX>.txt.
+The installer creates a log file on the path `C:\Users\(Username)\AppData\Local\Temp\Setup Log (Year-Month-Day) #XXX.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
+Any constructive contribution is very welcome! 
 
-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/).
+In order to fix a bug you have encountered, we require the log file from the installer. To view this log file, do the following:
 
-Double-click `HackWindowsInstall.iss` (from folder `src`), which will load it in Inno Setup and then select *Build* - *Compile*.
+- Click Start -> Click Run -> Enter *%temp%* to open your TEMP folder
+- Locate the file called Setup Log 2016-04-26 #xxx.txt where XXX should be 001
+- Double-click it and look into it to make sure it's the setup log from our installer. In the third line it should say *HackWindowsInstaller.exe*
+- Check the file for any information that you do not want others to see. For example, line 3,4 and 10 contain the paths where the setup is started from and how your TEMP folder is called. Just delete these lines. The other lines should be safe and only contain common information.
+- Open a new [issue](https://github.com/source-foundry/Hack-windows-installer/issues/new) in the Hack-Windows-Installer repository
+- Paste the entire text (minus the lines noted above) there 
 
 
 ## License

src/HackWindowsInstaller.iss

@@ -14,9 +14,6 @@
 
 
 
-//Disable the following line when releasing the setup
-//#define DEBUG
-
 //Update this when releasing a new version
 #define public Version '1.1.0'
 
@@ -28,7 +25,6 @@
 
 
 
-
 //--------------------------------------------------------------------
 //Get the base path of this setup. It is assumed that is located in a folder named "src" and the base path is the folder above it
 #define base_path StringChange(SourcePath,'src\','') 
@@ -37,8 +33,8 @@
 //Name of this setup
 #define public AppName 'Hack Windows Installer'
 
-//URL of the project homepage of the FONT 
-#define public HackMonospaced_Homepage 'http://sourcefoundry.org/hack/' /*'https://github.com/chrissimpkins/Hack'*/
+//URL of the project homepage for the FONT 
+#define public HackMonospaced_Homepage 'http://sourcefoundry.org/hack/'       /*'https://github.com/chrissimpkins/Hack'*/
 
 //URL of the installer homepage
 #define public Installer_Homepage 'https://github.com/source-foundry/Hack-windows-installer'
@@ -52,21 +48,18 @@
 #define public FontCache30Service 'FontCache3.0.0.0'
 
 
-
-
 //Total number of font entries we have
 #define total_fonts 4
-//--------------------------
-
 
+//Define font array
 #dim public font_source[total_fonts]
 #dim public font_file[total_fonts]
 #dim public font_name[total_fonts]
 
 //Counter for array
 #define cntr 0
 
-
+//---------------------------------------------------------
 
 #define font_source[cntr] HackMonospaced_Sourcefolder
 #define font_file[cntr] 'Hack-Bold.ttf'
@@ -88,8 +81,6 @@
 #define font_name[cntr] 'Hack Italic'
 #define cntr cntr+1
 
-
-
 //---------------------------------------------------------
 
 //Helper macro to generate a SHA1 hash for a font file
@@ -147,6 +138,10 @@ SetupIconFile=img\Hack-installer-icon.ico
 ;This icon will be displayed in Add/Remove programs and needs to be installed locally
 UninstallDisplayIcon={app}\Hack-installer-icon.ico
 
+;Folder configuration
+SourceDir={#base_path}
+OutputDir=out\
+OutputBaseFilename=HackWindowsInstaller
 
 ;Target folder settings
 DefaultDirName={pf}\Hack Windows Installer\
@@ -162,12 +157,7 @@ ArchitecturesInstallIn64BitMode=x64
 ;Only allow the installer to run on Windows 7 and upwards
 MinVersion=6.1
 
-;Folder configuration
-SourceDir={#base_path}
-OutputDir=out\
-OutputBaseFilename=HackWindowsInstaller
-
-;the file should be uninstallable
+;It should be uninstallable
 Uninstallable=Yes 
 
 Compression=lzma2/ultra
@@ -192,9 +182,9 @@ SetupWindowTitle={#AppName} {#Version}
 ;Message for the "Read to install" wizard page
   ;NOT USED - "Ready To Install" - below title bar
   ;WizardReady=
-;"Setup is now ready to begin installing ...."
+;ReadLabel1: "Setup is now ready to begin installing ...."
 ReadyLabel1=
-;"Click Install to continue with the installation" 
+;ReadyLabel2b: "Click Install to continue with the installation" 
 ReadyLabel2b=Setup is now ready to install the Hack fonts v{#HackMonospaced_Version} on your system.
 
 
@@ -203,7 +193,7 @@ ReadyLabel2b=Setup is now ready to install the Hack fonts v{#HackMonospaced_Vers
 [Icons]
 Name: "{app}\Fonts Applet"; Filename: "control.exe"; Parameters: "/name Microsoft.Fonts"; WorkingDir: "{win}";
 
-;The links to the homepage are only created if the user has selected the matching component
+;Link to the Hack homepage 
 Name: "{app}\Hack Homepage"; Filename: "{#HackMonospaced_Homepage}"; 
 
 
@@ -227,7 +217,7 @@ Source: "img\Hack-installer-icon.ico"; DestDir: "{app}"; Flags: ignoreversion;
 ;If a user copies *.TTF files to the "Fonts" applet and a font file with the same name already exists, Windows will simply append "_0" (or _1) to the font file and copy it.
 ;These "ghost" files need to be exterminated!
 
-;Helper macro to add something to a filename before the extension
+;Helper macro to add a string at the end oof filename, but before the extension
 #define public AddStringToEndOfFilename(str fileName, str whatToAdd) \
   StringChange(fileName, '.'+ExtractFileExt(filename), whatToAdd + '.' + ExtractFileExt(fileName))
 
@@ -243,7 +233,6 @@ Type: files; Name: "{fonts}\Hack-BoldOblique.ttf";
 Type: files; Name: "{fonts}\Hack-RegularOblique.ttf"; 
 
 
-
 
 [INI]
 ;Create an ini to make detection for enterprise deployment tools easy
@@ -456,13 +445,13 @@ begin
 end;
 
 
-//Prepare FontFiles and FontFilesHashes arrays
+//Prepare FontFiles* arrays
 procedure FillFontDataArray();
 begin
 
-//Helper macro to generate a pascal script function call with the font filename and the SHA1 hash 
-#define public AddFontDataMacro(str fileName, strFontName, str SHA1Hash) \
-  '  AddFontData(''' + fileName + ''', ''' + strFontName + ''', ''' + SHA1Hash + ''');'
+//Helper macro to generate a pascal script function call with the font filename, name and SHA1 hash 
+#define public AddFontDataMacro(str fileName, str FontName, str SHA1Hash) \
+  '  AddFontData(''' + fileName + ''', ''' + FontName + ''', ''' + SHA1Hash + ''');'
 
 //Generate AddFontData(....) calls
 #define public i 0  
@@ -488,7 +477,7 @@ begin
   //Fill font data arrays
   FillFontDataArray;
 
-  //Prepare the custom PrepareToInstall wizard page
+  //Prepare the custom PrepareToInstall wizard page where we show the progress of the service start/stop
   title:=SetupMessage(msgWizardPreparing);
   subTitle:=SetupMessage(msgPreparingDesc);
   
@@ -646,7 +635,7 @@ var
   currentFontFileNameWindows:string;
  
 begin
-  log('---BeforeInstallAction---');
+  log('---BeforeInstallAction START---');
 
   customPrepareToInstall.SetProgress(0, 0);
   customPrepareToInstall.Show;
@@ -720,7 +709,7 @@ end;
 //Show a custom prepare to install page in order to give the user output what we are doing
 procedure AfterInstallAction();
 begin
-  log('---AfterInstallAction---');
+  log('---AfterInstallAction START---');
 
   customPrepareToInstall.SetProgress(0, 0);
   customPrepareToInstall.Show;

src/HackWindowsInstaller_TEMP_Preprocessed.iss

@@ -18,8 +18,6 @@
 
 
 
-
-
 ; ISPP: Base Path C:\dev\git\Hack-windows-installer\
 
 
@@ -35,12 +33,6 @@
 
 
 
-
-
-
-
-
-
 
 
 
@@ -92,6 +84,10 @@ SetupIconFile=img\Hack-installer-icon.ico
 ;This icon will be displayed in Add/Remove programs and needs to be installed locally
 UninstallDisplayIcon={app}\Hack-installer-icon.ico
 
+;Folder configuration
+SourceDir=C:\dev\git\Hack-windows-installer\
+OutputDir=out\
+OutputBaseFilename=HackWindowsInstaller
 
 ;Target folder settings
 DefaultDirName={pf}\Hack Windows Installer\
@@ -107,12 +103,7 @@ ArchitecturesInstallIn64BitMode=x64
 ;Only allow the installer to run on Windows 7 and upwards
 MinVersion=6.1
 
-;Folder configuration
-SourceDir=C:\dev\git\Hack-windows-installer\
-OutputDir=out\
-OutputBaseFilename=HackWindowsInstaller
-
-;the file should be uninstallable
+;It should be uninstallable
 Uninstallable=Yes 
 
 Compression=lzma2/ultra
@@ -137,9 +128,9 @@ SetupWindowTitle=Hack Windows Installer 1.1.0
 ;Message for the "Read to install" wizard page
   ;NOT USED - "Ready To Install" - below title bar
   ;WizardReady=
-;"Setup is now ready to begin installing ...."
+;ReadLabel1: "Setup is now ready to begin installing ...."
 ReadyLabel1=
-;"Click Install to continue with the installation" 
+;ReadyLabel2b: "Click Install to continue with the installation" 
 ReadyLabel2b=Setup is now ready to install the Hack fonts v2.020 on your system.
 
 
@@ -148,7 +139,7 @@ ReadyLabel2b=Setup is now ready to install the Hack fonts v2.020 on your system.
 [Icons]
 Name: "{app}\Fonts Applet"; Filename: "control.exe"; Parameters: "/name Microsoft.Fonts"; WorkingDir: "{win}";
 
-;The links to the homepage are only created if the user has selected the matching component
+;Link to the Hack homepage 
 Name: "{app}\Hack Homepage"; Filename: "http://sourcefoundry.org/hack/"; 
 
 
@@ -170,7 +161,7 @@ Source: "img\Hack-installer-icon.ico"; DestDir: "{app}"; Flags: ignoreversion;
 ;If a user copies *.TTF files to the "Fonts" applet and a font file with the same name already exists, Windows will simply append "_0" (or _1) to the font file and copy it.
 ;These "ghost" files need to be exterminated!
 
-;Helper macro to add something to a filename before the extension
+;Helper macro to add a string at the end oof filename, but before the extension
 
   Type: files; Name: "{fonts}\Hack-Bold_*.ttf"; 
   Type: files; Name: "{fonts}\Hack-BoldItalic_*.ttf"; 
@@ -182,7 +173,6 @@ Type: files; Name: "{fonts}\Hack-BoldOblique.ttf";
 Type: files; Name: "{fonts}\Hack-RegularOblique.ttf"; 
 
 
-
 
 [INI]
 ;Create an ini to make detection for enterprise deployment tools easy
@@ -546,7 +536,7 @@ var
   currentFontFileNameWindows:string;
  
 begin
-  log('---BeforeInstallAction---');
+  log('---BeforeInstallAction START---');
 
   customPrepareToInstall.SetProgress(0, 0);
   customPrepareToInstall.Show;
@@ -612,7 +602,7 @@ end;
 
 procedure AfterInstallAction();
 begin
-  log('---AfterInstallAction---');
+  log('---AfterInstallAction START---');
 
   customPrepareToInstall.SetProgress(0, 0);
   customPrepareToInstall.Show;