Skip to content

Commit 89901a9

Browse files
committed
Update (regen) README
1 parent c6f30cd commit 89901a9

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -223,8 +223,11 @@ zproject's `project.xml` contains an extensive description of the available conf
223223
name := The name of your project (optional)
224224
description := A short description for your project (optional)
225225
email := The email address where to reach you (optional)
226+
url := The website or similar resource about the project or its ecosystem (optional)
226227
repository := git repository holding project (optional)
227228
unique_class_name := "0"|"1" (optional, defaults to 0) As a failsafe, forbid naming agents or classes same as the project itself (can cause conflicts in generated header filenames). Disable explicitly (set to 0) only in legacy projects that can not regenerate otherwise, and try to fix those.
229+
license := optional common tag of the project's license ("MPLv2", "GPL-2.0+", "CompanyName Proprietary" etc.); see also license.xml for longer wording
230+
check_license_years := "0"|"1"|"2" (optional, defaults to 0) When a project is regenerated, and if any license text(s) are defined, we check that at least one Copyright line in at least one license text contains the current year, and warn if not. If this option is set to "1", we also pause so that interactive developers can see this warning better and intervene. With "2" require that the year is mentioned, abort GSL with year if it is not.
228231
-->
229232
<project script = "zproject.gsl" name = "zproject"
230233
@@ -237,7 +240,10 @@ zproject's `project.xml` contains an extensive description of the available conf
237240
part of the XML tree. This file can provide content of such tags
238241
as <license> (detailed text to put in generated file headers)
239242
and <starting_year> (a number to put in packaging copyright
240-
summaries).
243+
summaries). Note that a verbatim "license.xml" file would be
244+
created if it is currently missing but the tag is present, and
245+
then it would be seeded with a current starting_year and some
246+
boilerplate reminder to specify a real license and copyright.
241247
-->
242248
<include filename = "license.xml" />
243249

0 commit comments

Comments
 (0)