Skip to content

Commit 01c8272

Browse files
committed
Update
1 parent 9867973 commit 01c8272

File tree

1 file changed

+17
-13
lines changed

1 file changed

+17
-13
lines changed

README.md

Lines changed: 17 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -195,9 +195,11 @@ Now, take a look at the `HelloWorld.pupnet.conf` in the root of the project.
195195
<img src="Media/Screenie-Configuration.png" style="width:60%;max-width:400px;"/>
196196
</p>
197197

198-
This is a simple ini file in which the deployment project is configured. You will see that each parameter is documented.
199-
Where local paths are given, they are local to the `.conf` file, rather than your current working directory.
200-
Always use the forward-slash '/' as a path separator for cross-platform compatibility.
198+
This is a simple ini file in which the deployment project is configured. Where local paths are given, they are local
199+
to the `.conf` file, rather than your current working directory. Always use the forward-slash '/' as a path separator
200+
for cross-platform compatibility.
201+
202+
You will see that each parameter is documented. However, we will discuss key properties and issues below.
201203

202204
### Desktop File <a name="desktop-file"/>
203205

@@ -257,14 +259,14 @@ detail information, see [AppStream Metadata Quick Start](https://www.freedesktop
257259
If you omit the `MetaFile` property, no `.metainfo.xml` file is shipped with your application. But let's assume you
258260
wish to provide metadata, so take a look at the file provided under: `Deploy/app.metainfo.xml` in the Hello World demo.
259261

260-
Again, you will notice that macro variables are used. These are entirely optional here and simply mean, that as far
262+
Again, you will notice that macro variables are used. These are entirely optional here and simply mean that, as far
261263
as possible, deployment configuration data is specified in one place only (i.e. your `pupnet.conf` file). However,
262264
you may still wish to edit and extend this file to provide a screenshot, international language translations and
263265
additional information such as keywords.
264266

265267
**IMPORTANT:** Since PupNet version 1.4.0, the macros `${APPSTREAM_DESCRIPTION_XML}` and `${APPSTREAM_CHANGELOG_XML}`
266268
may be used to auto-populate the default application description, and change (release) information. These are described
267-
in more detail below.
269+
in more detail below under [Application Versioning](#application-versioning-changelog).
268270

269271
**Hint:** You can use PupNet itself to generate a metadata template file for a new project:
270272

@@ -291,11 +293,11 @@ Multiple desktop icons are provided with the `IconPaths` parameter. You can use
291293
Note the use of *triple quotes* here for multi-line values.
292294

293295
Use only the `svg`, `png` and `ico` file types. On Linux, `svg` and `png` files will be installed appropriately and the
294-
Windows `ico` file ignored.
295-
296-
**IMPORTANT:** It is necessary to specify the size of PNG files by embedding their size in the filename, as shown, or simply as: `name.64.png`.
296+
Windows `ico` file ignored. For Windows `Setup` packages, on the other hand, only the `ico` file is used, and PNG and SVG
297+
files are ignored.
297298

298-
For Windows `Setup` packages, on the other hand, only the `ico` file is used, and PNG and SVG files are ignored.
299+
**IMPORTANT:** It is necessary to specify the size of PNG files by embedding their size in the filename, as shown above,
300+
or simply as: `name.64.png`.
299301

300302

301303
### Dotnet Project Path <a name="dotnet-project-path"/>
@@ -320,7 +322,7 @@ configuration and command line arguments.
320322

321323
As an absolute minimum, we always want to include `--self-contained true`, as this will cause dotnet not only to
322324
compile the application, but to publish all dependencies into a single directory. (From .NET8 onward you may wish to
323-
consider using Native AOT as well).
325+
consider using Native AOT).
324326

325327

326328
### Application Versioning & Changelog <a name="application-versioning-changelog"/>
@@ -355,7 +357,8 @@ macro variable which may optionally be used within the `<release>` element of yo
355357
that lengthy version change information need only be specified once (in a changelog or README file).
356358

357359
Version change information is to be provided as one or more version release sections prefixed with '+' and a leading
358-
version number, suffixed with trailing date, with subsequent change items prefixed with '-', as follows:
360+
version number, and suffixed with trailing date. Subsequent change items are prefixed with '-', as shown below.
361+
Note that ';' is used as a separator.
359362

360363
+ VERSION;[Other fields ignored;]yyyy-MM-dd
361364
- Change feature 3
@@ -365,8 +368,8 @@ version number, suffixed with trailing date, with subsequent change items prefix
365368
- Change feature 1
366369
- Change feature 2
367370

368-
Note that ';' is used as a separator. Additional fields, between the VERSION number and trailing date, may used to
369-
ive a version title and/or maintainer contact, as below.
371+
Additional fields, between the VERSION number and trailing date, may used as you wish, i.e. to give a version title
372+
and/or maintainer contact information, as below.
370373

371374
+ VERSION 1.3.1; Patch Release; [email protected]; 2023-05-01
372375
- Bugfix: Fix package creation when file path of contents contain spaces (enclose file path with quotes when executing chmod)
@@ -383,6 +386,7 @@ The following two examples are "legal":
383386
describing feature 3
384387
- Change feature 4
385388

389+
386390
+ 1.3.1;2023-05-01
387391

388392
- Long change line

0 commit comments

Comments
 (0)