You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Most changes relate to revised CodeSnip license.
Add new "Conditions For Release of Modified Code" section to explain
changes to code required to remove CodeSnip branding etc.
Revise "Get the Source Code" sub-section and add note linking to above
new section.
Update source code tree to include new Src/Res/Img/AltBranding
directory.
Fix size of mono fonts used by code and pre tags.
Fix minor typo
Type library importer tool. Used to create a Pascal unit that describes
160
-
code contained in <code>ExternalObj.idl</code>.
163
+
code contained in <code>ExternalObj.ridl</code>.
161
164
</dd>
162
165
</dl>
163
166
@@ -376,30 +379,34 @@ <h3>
376
379
</h3>
377
380
378
381
<p>
379
-
The source code is maintained in the <code><ahref="https://github.com/delphidabbler/codesnip">delphidabbler/codesnip</a></code> Git respository on GitHub.
382
+
The source code is maintained in the <code><ahref="https://github.com/delphidabbler/codesnip">delphidabbler/codesnip</a></code> Git respository on GitHub. Source code can be obtained in three ways:
380
383
</p>
381
384
382
-
<p>
383
-
If you are intending to contribute code to the project you need to:
384
-
</p>
385
-
386
-
<olclass="spaced">
387
-
<li>
388
-
Fork the project on GitHub.
389
-
</li>
385
+
<ol>
390
386
<li>
391
-
Create a new branch off the <code>development</code> branch.
387
+
<p>
388
+
Fork the project from GitHub and then clone your forked repository.
Once finished raise a pull request for your code on the <code>delphidabbler/codesnip</code> repo.
398
+
<p>
399
+
Download the source of a specific release from the project's <ahref="https://github.com/delphidabbler/codesnip/releases">Releases</a> section on GitHub – just choose the version you want.
400
+
</p>
398
401
</li>
399
402
</ol>
400
403
401
404
<p>
402
-
If you only intend to use the code for your own purposes you can still fork the repository as above. Alternatively you can download the source code from the project's <ahref="https://github.com/delphidabbler/codesnip/releases">Releases</a> section on GitHub – just choose the version you want.
405
+
If you are intending to contribute code to the project please read the most up to date version of the project's <ahref="https://github.com/delphidabbler/codesnip/blob/develop/README.md">read-me file</a> before doing so.
406
+
</p>
407
+
408
+
<pclass="note">
409
+
<strong>Important:</strong> If you are planning to fork <em>CodeSnip</em> and to develop and release your own application derived from the CodeSnip code base then some changes to the code are required under the terms of the <em>CodeSnip</em> license. See the <ahref="#conditions">Conditions For Release of Modified Code</a> section below for details.
403
410
</p>
404
411
405
412
<h3>
@@ -412,53 +419,55 @@ <h3>
412
419
413
420
<pre>./
414
421
|
415
-
+-- Docs - documentation
422
+
+-- Docs - documentation
416
423
| |
417
-
| +-- Design - documents concerning program design
424
+
| +-- Design - documents concerning program design
418
425
| |
419
-
| +-- FileFormats - documentation of CodeSnip's file formats
426
+
| +-- FileFormats - documentation of CodeSnip's file formats
420
427
|
421
-
+-- Src - main CodeSnip source code
428
+
+-- Src - main CodeSnip source code
422
429
| |
423
-
| +-- 3rdParty - third party & DelphiDabbler library source code
430
+
| +-- 3rdParty - third party & DelphiDabbler library source code
| | +-- Assets - files required for inclusion in install program
444
+
| | +-- Assets - files required for inclusion in install program
438
445
| |
439
-
| +-- Res - container for files that are embedded in resources
446
+
| +-- Res - container for files that are embedded in resources
440
447
| |
441
-
| +-- CSS - CSS files
448
+
| +-- CSS - CSS files
442
449
| |
443
-
| +-- HTML - HTML files
450
+
| +-- HTML - HTML files
444
451
| |
445
-
| +-- Img - image files
452
+
| +-- Img - image files
453
+
| | |
454
+
| | +-- AltBranding - image files used for 3rd party branding
446
455
| | |
447
-
| | +-- Branding - image files used for CodeSnip branding
456
+
| | +-- Branding - image files used for CodeSnip branding only
448
457
| | |
449
-
| | +-- Egg - image files for 'Easter Egg'
458
+
| | +-- Egg - image files for 'Easter Egg'
450
459
| |
451
-
| +-- Misc - other resources
460
+
| +-- Misc - other resources
452
461
| |
453
-
| +-- Scripts - scripting files
462
+
| +-- Scripts - scripting files
454
463
| |
455
-
| +-- 3rdParty - 3rd party scripting files
464
+
| +-- 3rdParty - 3rd party scripting files
456
465
|
457
-
+-- Tests - contains test code
466
+
+-- Tests - contains test code
458
467
|
459
-
+-- Src - test source code
468
+
+-- Src - test source code
460
469
|
461
-
+-- DUnit - test source code that uses the DUnit framework</pre>
470
+
+-- DUnit - test source code that uses the DUnit framework</pre>
462
471
<p>
463
472
If, by chance you also have a <code>_build</code> directory don't worry - all will become clear.
464
473
Git users may also see the usual <code>.git</code> hidden
@@ -497,13 +506,13 @@ <h3>
497
506
498
507
<pre>./
499
508
|
500
-
+-- _build - contains all the build files
509
+
+-- _build - contains all the build files
501
510
| |
502
-
| +-- bin - receives object files for CodeSnip
511
+
| +-- bin - receives object files for CodeSnip
503
512
| |
504
-
| +-- exe - receives executable code and compiled help file
513
+
| +-- exe - receives executable code and compiled help file
505
514
| |
506
-
| +-- release - receives release files
515
+
| +-- release - receives release files
507
516
|
508
517
...</pre>
509
518
@@ -861,22 +870,22 @@ <h2>
861
870
</p>
862
871
863
872
<p>
864
-
To compile the tests, open the <code>.\Src\CodeSnip.groupproj</code> group
873
+
To compile the tests, open the <code>Src\CodeSnip.groupproj</code> group
865
874
project file in the Delphi XE IDE. Now select the <em>CodeSnipTests.exe</em>
866
875
target in the project manager and compile.
867
876
</p>
868
877
869
878
<p>
870
879
If they were not already present <code>Bin</code> and <code>Exe</code>
871
-
sub-directories will have been created in the <code>.\Tests</code> directory.
880
+
sub-directories will have been created in the <code>Tests</code> directory.
872
881
The <code>Exe</code> directory contains the <em>DUnit</em> test program while
873
882
<code>Bin</code> contains intermediate binaries.
874
883
</p>
875
884
876
885
<p>
877
886
You can compile the tests as either a GUI application (default) or as a
878
887
console application. For details please see the comments in
879
-
<code>.\Tests\Src\DUnit\CodeSnipTests.dpr</code>.
888
+
<code>Tests\Src\DUnit\CodeSnipTests.dpr</code>.
880
889
</p>
881
890
882
891
<h2>
@@ -893,6 +902,67 @@ <h2>
893
902
directory.
894
903
</p>
895
904
905
+
<h2id="conditions">
906
+
Conditions For Release of Modified Code
907
+
</h2>
908
+
909
+
<p>
910
+
If you are intending to release your own application based on the <em>CodeSnip</em> source code you <strong>must</strong><em>either</em> change the source code as described below <em>or</em> seek written permission to use the DelphiDabbler CodeSnip branding. To seek such permission please use the <em>CodeSnip</em><ahref="https://github.com/delphidabbler/codesnip/issues">Issue Tracker</a> on GitHub.
911
+
</p>
912
+
913
+
<h3>
914
+
Required Changes
915
+
</h3>
916
+
917
+
<p>
918
+
The changes are required to remove DelphiDabbler CodeSnip copyrighted branding from the program, to prevent interference with existing CodeSnip installations and to remove any implied endorsement of the modified release. You <strong>must</strong>:
919
+
</p>
920
+
921
+
<ol>
922
+
<li>
923
+
<p>
924
+
Replace the files in the <code>Src\Res\Img\Branding</code> directory with copies of the identically named placeholder files in the <code>Src\Res\Img\AltBranding</code> directory. The placeholder files are Public Domain, so you may use them as-is, edit them or replace them. If you delete the files in <code>Src\Res\Img\Branding</code> without copying the placeholder files across then <em>CodeSnip</em> will fail to build.
925
+
</p>
926
+
</li>
927
+
<li>
928
+
<p>
929
+
Replace all relevant references, in source code and documentation, to the names "CodeSnip" and "DelphiDabbler" with your own company and program name. Relevant occurences are:
930
+
</p>
931
+
<ul>
932
+
<li>
933
+
Wherever the names may be displayed in the GUI.
934
+
</li>
935
+
<li>
936
+
Wherever the names may be displayed by the installer.
937
+
</li>
938
+
<li>
939
+
Wherever the names occur in directory names. In particular do not use the names in the program's <code>%ProgramData%</code> and <code>%AppData%</code> sub-directories.
940
+
</li>
941
+
<li>
942
+
Anywhere else that use of the names could imply endorsement of the modified code.
943
+
</li>
944
+
</ul>
945
+
</li>
946
+
<li>
947
+
<p>
948
+
Provide your own license file with content compatible with the requirements of the <em>CodeSnip</em> license as it relates to the code reused from the <em>CodeSnip</em> source tree. <strong>Do not</strong> edit or re-use <code>Docs/License.html</code>.
949
+
</p>
950
+
</li>
951
+
<li>
952
+
<p>
953
+
Modify source code and documentation where necessary to acknowledge the origins of the program's source code, documentation and images, in accordance with the <em>CodeSnip</em> license.
954
+
</p>
955
+
</li>
956
+
</ol>
957
+
958
+
<p>
959
+
Note that the <em>CodeSnip</em> license can be found in <code>Docs\License.html</code>.
960
+
</p>
961
+
962
+
<p>
963
+
If you are unsure about whether your changes meet the license requirements then you can seek clarification by creating an issue on the aforementioned <ahref="https://github.com/delphidabbler/codesnip/issues">Issue Tracker</a>.
0 commit comments