Merge branch 'feature/78-update-build-process' into develop

Closes #78

Author: delphidabbler

.gitignore

@@ -10,8 +10,6 @@
 __history/
 
 # Project specific directories & files
-Bin
-Exe
-Release
+_build
 Src/CodeSnip.cfg
 Src/AutoGen/IntfExternalObj.pas

Build.html

@@ -460,8 +460,7 @@ <h3>
           |
           +-- DUnit         - test source code that uses the DUnit framework</pre>
 <p>
-  If, by chance you also have <code>Bin</code>, <code>Exe</code> and / or
-  <code>Release</code> directories don't worry - all will become clear.
+  If, by chance you also have a <code>_build</code> directory don't worry - all will become clear.
   Git users may also see the usual <code>.git</code> hidden
   directory. If you have done some editing in the Delphi IDE you may also see
   occasional hidden <code>__history</code> folders.
@@ -498,18 +497,18 @@ <h3>
 
 <pre>./
   |
-  +-- Bin                   - receives object files for CodeSnip
-  |
-  ...
-  |
-  +-- Exe                   - receives executable code and compiled help file
-  |
-  +-- Release               - receives release files
+  +-- _build                - contains all the build files
+  |   |
+  |   +-- bin               - receives object files for CodeSnip
+  |   |
+  |   +-- exe               - receives executable code and compiled help file
+  |   |
+  |   +-- release           - receives release files
   |
   ...</pre>
 
 <p>
-  If the <code>Bin</code> folder already existed, it will have been emptied.
+  If the <code>_build/bin</code> folder already existed, it will have been emptied.
   In addition, <code>Make</code> will have created a <code>.cfg</code> file from
   template in the <code>Src</code> folder. This <code>.cfg</code> file is needed
   for DCC32 to run correctly. The file will be ignored by Git.
@@ -625,7 +624,7 @@ <h3>
 
 <p>
   The <em>CodeSnip</em> executable, named <code>CodeSnip.exe</code> will be
-  placed in the <code>Exe</code> folder.
+  placed in the <code>_build\exe</code> folder.
 </p>
 
 <h4>
@@ -640,7 +639,7 @@ <h4>
 <pre class="cmd"><span class="prompt">&gt;</span> Make -DPORTABLE codesnip</pre>
 
 <p>
-  Again the executable is placed in the <code>Exe</code> folder, but this time
+  Again the executable is placed in the <code>_build/exe</code> folder, but this time
   it is named <code>CodeSnip-p.exe</code>
 </p>
 
@@ -654,13 +653,16 @@ <h3>
 
 <pre class="cmd"><span class="prompt">&gt;</span> Make help</pre>
 
+<p>
+  The compiled help file will be written to the <code>_build\exe</code> folder.
+</p>
 <h3>
   Build the Setup Program
 </h3>
 
 <p>
   The setup program requires that the <em>CodeSnip</em> excutable and the
-  compiled help file are already present in the <code>Exe</code> directory.
+  compiled help file are already present in the <code>_build\exe</code> directory.
 </p>
 
 <p>
@@ -679,7 +681,7 @@ <h3>
 <p>
   The setup program is named <code>CodeSnip-Setup-x.x.x.exe</code>, where
   x.x.x is the version number extracted from <em>CodeSnip</em>'s version
-  information. It is placed in the <code>Exe</code> directory.
+  information. It is placed in the <code>_build/exe</code> directory.
 </p>
 
 <p>
@@ -704,6 +706,7 @@ <h3>
 
 <p>
   Make can create zip files containing all the files that are included in a release.
+  Zip files are written to the <code>_build/release</code> directory.
 </p>
 
 <h4>
@@ -723,13 +726,17 @@ <h4>
 <pre class="cmd"><span class="prompt">&gt;</span> Make release</pre>
 
 <p>
-  By default the release file is named <code>dd-codesnip.zip</code>. You can
+  By default the release file is named <code>codesnip-exe.zip</code>. You can
   change this name by defining the <code>RELEASEFILENAME</code> macro or
   enviroment variable. For example, you can name the file
   <code>MyRelease.zip</code> by doing:
 </p>
 
-<pre class="cmd"><span class="prompt">&gt;</span> Make -DRELEASEFILENAME=MyRelease.zip release</pre>
+<pre class="cmd"><span class="prompt">&gt;</span> Make -DRELEASEFILENAME=MyRelease release</pre>
+
+<p>
+  Note that the <code>.zip</code> extension should not be included in the file name.
+</p>
 
 <h4>
   Portable edition
@@ -754,7 +761,11 @@ <h4>
   <code>MyPortableRelease.zip</code> by doing:
 </p>
 
-<pre class="cmd"><span class="prompt">&gt;</span> Make -DPORTABLE -DRELEASEFILENAME=MyPortableRelease.zip release</pre>
+<pre class="cmd"><span class="prompt">&gt;</span> Make -DPORTABLE -DRELEASEFILENAME=MyPortableRelease release</pre>
+
+<p>
+  Once again note that the <code>.zip</code> extension should not be included in the file name.
+</p>
 
 <p class="note">
   <strong>Warning:</strong> If you are building both the standard and portable
@@ -763,6 +774,35 @@ <h4>
   built release will overwrite the first.
 </p>
 
+<h4>
+  Including version numbers in zip file names
+</h4>
+
+<p>
+  A version number can be suffixed to the release zip file name by defining the <code>VERSION</code> macro.
+  This macro works with both the <code>PORTABLE</code> and <code>RELEASEFILENAME</code> macros.
+</p>
+
+<p>
+  For example to appended version number 4.22.0 to the zip file name on a standard edition build, with the default
+  file name do:
+</p>
+
+<pre class="cmd"><span class="prompt">&gt;</span> Make -DVERSION=4.22.0 release</pre>
+
+<p>
+  This will create a zip file named <code>codesnip-exe-4.22.0.zip</code>.
+</p>
+
+<p>
+  A more complex example would be to append the same version number to a portable edition build named <code>MyPortableRelease</code>. Do:
+</p>
+
+<pre class="cmd"><span class="prompt">&gt;</span> Make -DPORTABLE -DRELEASEFILENAME=MyPortableRelease -DVERSION=4.22.0 release</pre>
+
+<p>
+  This time the resulting zip file will be named <code>MyPortableRelease-4.22.0.zip</code>.
+</p>
 
 <h3>
   Build and Release Everything
@@ -784,16 +824,17 @@ <h3>
 <span class="prompt">&gt;</span> Make setup
 <span class="prompt">&gt;</span> Make release</pre>
 
-<h4>
-  Portable edition
-</h4>
-
 <p>
   To perform a complete build of the portable edition of <em>CodeSnip</em> do
 </p>
 
 <pre class="cmd"><span class="prompt">&gt;</span> Make -DPORTABLE</pre>
 
+<p>
+  Note that the <code>RELEASEFILENAME</code> and <code>VERSION</code> macros that can be used for customising
+  zip file names can be used here too.
+</p>
+
 <h3>
   Clean Up
 </h3>

Src/CodeSnip.cfg.tplt

@@ -30,12 +30,12 @@
 -M
 -$M16384,1048576
 -K$00400000
--E"..\Exe"
--N0"..\Bin"
--U"..\Bin;3rdParty"
--O"..\Bin;3rdParty"
--I"..\Bin;3rdParty"
--R"..\Bin;3rdParty"
+-E"..\_build\exe"
+-N0"..\_build\bin"
+-U"..\_build\bin;3rdParty"
+-O"..\_build\bin;3rdParty"
+-I"..\_build\bin;3rdParty"
+-R"..\_build\bin;3rdParty"
 -w-SYMBOL_PLATFORM
 -w+EXPLICIT_STRING_CAST_LOSS
 -w+CVT_WIDENING_STRING_LOST

Src/CodeSnip.dproj

@@ -16,9 +16,9 @@
 		<PropertyGroup Condition="'$(Base)'!=''">
 			<DCC_UnitAlias>WinTypes=Windows;WinProcs=Windows;DbiTypes=BDE;DbiProcs=BDE;DbiErrs=BDE;$(DCC_UnitAlias)</DCC_UnitAlias>
 			<DCC_SYMBOL_PLATFORM>false</DCC_SYMBOL_PLATFORM>
-			<DCC_ExeOutput>..\Exe</DCC_ExeOutput>
-			<DCC_UnitSearchPath>..\Bin;3rdParty;$(DCC_UnitSearchPath)</DCC_UnitSearchPath>
-			<DCC_DependencyCheckOutputName>..\Exe\CodeSnip.exe</DCC_DependencyCheckOutputName>
+			<DCC_ExeOutput>..\_build\exe</DCC_ExeOutput>
+			<DCC_UnitSearchPath>..\_build\bin;3rdParty;$(DCC_UnitSearchPath)</DCC_UnitSearchPath>
+			<DCC_DependencyCheckOutputName>..\_build\exe\CodeSnip.exe</DCC_DependencyCheckOutputName>
 			<DCC_CVT_WIDENING_STRING_LOST>true</DCC_CVT_WIDENING_STRING_LOST>
 			<DCC_CVT_ACHAR_TO_WCHAR>true</DCC_CVT_ACHAR_TO_WCHAR>
 			<DCC_Platform>x86</DCC_Platform>
@@ -29,7 +29,7 @@
 			<DCC_S>false</DCC_S>
 			<DCC_F>false</DCC_F>
 			<DCC_SymbolReferenceInfo>1</DCC_SymbolReferenceInfo>
-			<DCC_DcuOutput>..\Bin</DCC_DcuOutput>
+			<DCC_DcuOutput>..\_build\bin</DCC_DcuOutput>
 			<DCC_E>false</DCC_E>
 		</PropertyGroup>
 		<ItemGroup>

Src/Help/CodeSnip.hhp

@@ -8,7 +8,7 @@
 
 [OPTIONS]
 Compatibility=1.1
-Compiled file=..\..\Exe\CodeSnip.chm
+Compiled file=..\..\_build\exe\CodeSnip.chm
 Contents file=TOC.hhc
 Default topic=HTML\welcome.htm
 Display compile progress=No

Src/Install/CodeSnip.iss

@@ -2,7 +2,7 @@
 ; v. 2.0. If a copy of the MPL was not distributed with this file, You can
 ; obtain one at https://mozilla.org/MPL/2.0/
 ;
-; Copyright (C) 2006-2021, Peter Johnson (gravatar.com/delphidabbler).
+; Copyright (C) 2006-2022, Peter Johnson (gravatar.com/delphidabbler).
 ;
 ; Install file generation script for use with Inno Setup.
 
@@ -25,10 +25,10 @@
 #define ReadMeFile "ReadMe.txt"
 #define LicenseFile "License.rtf"
 #define LicenseTextFile "License.html"
-#define OutDir SourcePath + "..\..\Exe"
+#define OutDir SourcePath + "..\..\_build\exe"
 #define SrcDocsPath SourcePath + "..\..\Docs\"
-#define SrcAssetsPath SourcePath + '\Assets\"
-#define SrcExePath SourcePath + "..\..\Exe\"
+#define SrcAssetsPath SourcePath + "\Assets\"
+#define SrcExePath SourcePath + "..\..\_build\exe\"
 #define ProgDataSubDir AppName + ".4"
 #define ExeProg SrcExePath + ExeFile
 #define AppVersion DeleteToVerStart(GetFileProductVersion(ExeProg))