6
6
* v. 2.0. If a copy of the MPL was not distributed with this file, You can
7
7
* obtain one at https://mozilla.org/MPL/2.0/
8
8
*
9
- * Copyright (C) 2009-2023 , Peter Johnson (gravatar.com/delphidabbler).
9
+ * Copyright (C) 2009-2024 , Peter Johnson (gravatar.com/delphidabbler).
10
10
*
11
11
* Instructions for building CodeSnip from source.
12
12
-->
@@ -513,12 +513,14 @@ <h3>
513
513
| +-- exe - receives executable code and compiled help file
514
514
| |
515
515
| +-- release - receives release files
516
+ | |
517
+ | +-- ~tmp~ - store for temp files ceated in release process
516
518
|
517
519
...</ pre >
518
520
519
521
< p >
520
522
If the < code > _build/bin</ code > folder already existed, it will have been emptied.
521
- In addition, < code > Make</ code > will have created a < code > .cfg</ code > file from
523
+ In addition, < code > Make</ code > will have created a < code > .cfg</ code > file from a
522
524
template in the < code > Src</ code > folder. This < code > .cfg</ code > file is needed
523
525
for DCC32 to run correctly. The file will be ignored by Git.
524
526
</ p >
580
582
You have several options:
581
583
</ p >
582
584
583
- < ul class ="spaced ">
585
+ < ol class ="spaced ">
584
586
< li >
585
587
Build the < em > CodeSnip</ em > Executable
586
588
</ li >
@@ -599,10 +601,10 @@ <h2>
599
601
< li >
600
602
Clean Up.
601
603
</ li >
602
- </ ul >
604
+ </ ol >
603
605
604
606
< p >
605
- Each of these options is described below. All except the last assume that
607
+ Each of these options is described below. All except options 5 and 6 assume that
606
608
< code > Make config</ code > has been run.
607
609
</ p >
608
610
648
650
< pre class ="cmd "> < span class ="prompt "> ></ span > Make -DPORTABLE codesnip</ pre >
649
651
650
652
< p >
651
- Again the executable is placed in the < code > _build/ exe</ code > folder, but this time
653
+ Again the executable is placed in the < code > _build\ exe</ code > folder, but this time
652
654
it is named < code > CodeSnip-p.exe</ code >
653
655
</ p >
654
656
@@ -665,12 +667,17 @@ <h3>
665
667
< p >
666
668
The compiled help file will be written to the < code > _build\exe</ code > folder.
667
669
</ p >
670
+
671
+ < p >
672
+ The same help file is used for the standard and portable editions.
673
+ </ p >
674
+
668
675
< h3 >
669
676
Build the Setup Program
670
677
</ h3 >
671
678
672
679
< p >
673
- The setup program requires that the < em > CodeSnip</ em > excutable and the
680
+ The setup program requires that the < em > CodeSnip</ em > executable and the
674
681
compiled help file are already present in the < code > _build\exe</ code > directory.
675
682
</ p >
676
683
690
697
< p >
691
698
The setup program is named < code > CodeSnip-Setup-x.x.x.exe</ code > , where
692
699
x.x.x is the version number extracted from < em > CodeSnip</ em > 's version
693
- information. It is placed in the < code > _build/ exe</ code > directory.
700
+ information. It is placed in the < code > _build\ exe</ code > directory.
694
701
</ p >
695
702
696
703
< p >
715
722
716
723
< p >
717
724
Make can create zip files containing all the files that are included in a release.
718
- Zip files are written to the < code > _build/ release</ code > directory.
725
+ Zip files are written to the < code > _build\ release</ code > directory.
719
726
</ p >
720
727
721
728
< h4 >
@@ -724,12 +731,12 @@ <h4>
724
731
725
732
< p >
726
733
The release zip file for the standard edition requires that the setup files is already
727
- present in the < code > _build/ exe</ code > directory.
734
+ present in the < code > _build\ exe</ code > directory.
728
735
</ p >
729
736
730
737
< p >
731
738
The release file includes the setup file along with < code > ReadMe.txt</ code >
732
- that is automatically generated from < code > Docs/ ReadMe-standard.txt</ code > .
739
+ that is automatically generated from < code > Docs\ ReadMe-standard.txt</ code > .
733
740
</ p >
734
741
735
742
< p >
763
770
764
771
< p >
765
772
The release file includes the portable executable file, < code > CodeSnip-p.exe</ code > ,
766
- the help file < code > CodeSnip.chm</ code > , < code > Docs/ License.html</ code > and
773
+ the help file < code > CodeSnip.chm</ code > , < code > Docs\ License.html</ code > and
767
774
< code > ReadMe.txt</ code > that is automatically generated from
768
- < code > Docs/ ReadMe-portable.txt</ code > .
775
+ < code > Docs\ ReadMe-portable.txt</ code > .
769
776
</ p >
770
777
771
778
< p >
@@ -855,6 +862,31 @@ <h3>
855
862
zip file names can be used here too.
856
863
</ p >
857
864
865
+ < p >
866
+ There is also a quicker way to build a release, but you must provide a version number to use it. First navigate up
867
+ to the repository root. Then run
868
+ </ p >
869
+
870
+ < pre class ="cmd "> < span class ="prompt "> ></ span > Deploy 9.9.9</ pre >
871
+
872
+ < p >
873
+ where < code > 9.9.9</ code > is the release version number.
874
+ </ p >
875
+
876
+ < p >
877
+ This command will build both the standard and portable executables, the help file, the standard edition setup file
878
+ and finally create the release zip files for both editions, with the release version number incorporated in the file names.
879
+ </ p >
880
+
881
+ < p >
882
+ Using < code > Deploy 9.9.9</ code > is the equivalent of doing:
883
+ </ p >
884
+
885
+ < pre class ="cmd "> < span class ="prompt "> ></ span > cd Src
886
+ < span class ="prompt "> ></ span > Make -DVERSION=9.9.9
887
+ < span class ="prompt "> ></ span > Make -DPORTABLE -DVERSION=9.9.9
888
+ < span class ="prompt "> ></ span > cd ..</ pre >
889
+
858
890
< h3 >
859
891
Clean Up
860
892
</ h3 >
0 commit comments