Skip to content

Commit a1293bc

Browse files
committed
Use and document the new description field
1 parent 1f4b754 commit a1293bc

File tree

3 files changed

+5
-3
lines changed

3 files changed

+5
-3
lines changed

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ python Tools/BuildAddOn.py --configFile config.json
2929
The build script reads the config.json file for required build parameters:
3030

3131
- `addOnName`: name of the Add-On.
32+
- `description`: description of the Add-On.
3233
- `defaultLanguage`: a single language for which the Add-On is built when localization is not enabled. Must be one of the languages specified in `languages`.
3334
- `languages`: list of languages, for which localization can be done / for which the .grc files are present in their respective directories.
3435
- `version`: version of the Add-On. Must have 1, 2 or 3 numeric components (`123`, `1.23` or `1.2.3` respectively) all of which must be in the `0-65535` range.
@@ -65,7 +66,7 @@ git submodule update --remote
6566
The version number `0.0.0` (or `0.0` or `0` according to the rules above) is recognized as a placeholder and using it will result in a warning.
6667
This template contains a `version` value with this placeholder value that should be changed.
6768

68-
You may also want to change the `addOnName` and `copyright` values.
69+
You may also want to change the `addOnName`, `description` and `copyright` values.
6970
You may use the `%Y` placeholder in the `copyright.year` field to always refer to the current year.
7071

7172
### Build with downloaded Archicad API Development Kit

config.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,5 +8,6 @@
88
"copyright": {
99
"name": "Graphisoft SE",
1010
"year": "1984-%Y"
11-
}
11+
},
12+
"description": "Example Archicad addon"
1213
}

0 commit comments

Comments
 (0)