Skip to content

Commit 77b026c

Browse files
committed
Update
1 parent 01c8272 commit 77b026c

File tree

1 file changed

+29
-27
lines changed

1 file changed

+29
-27
lines changed

README.md

Lines changed: 29 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -420,7 +420,7 @@ For a GUI application, you will want to ensure the following:
420420
DesktopNoDisplay = false
421421
DesktopTerminal = false
422422

423-
You may typically leave `StartCommand` empty, but may set if you wish.
423+
You may typically leave `StartCommand` empty, but may set it if you wish.
424424

425425
#### Terminal Application ####
426426
IMPORTANT: Your terminal application will not be in the user's path by default, so note `StartCommand` and
@@ -431,15 +431,17 @@ IMPORTANT: Your terminal application will not be in the user's path by default,
431431
StartCommand = command-name
432432
SetupCommandPrompt = Command Prompt
433433

434-
(You may wish, however, to provide a desktop entry for your terminal app by setting `DesktopNoDisplay` to false.)
434+
For command line only apps, you would typically set `DesktopNoDisplay` true, but you may give your application a desktop
435+
entry by setting it to false if you wish.
435436

436-
With `StartCommand`, you should set a simple command name for application which will be located in the path. This will be
437-
realized via a tiny bash script on Linux, or bat file on Windows, which will launch your main application. If, for example,
438-
your runnable file is something like 'Zone.Kuiper.HelloWorld', you may set `StartCommand` simply to 'helloworld'.
437+
With `StartCommand`, you should set a simple command name for application which will be located in the user's path after
438+
installation. This will actually be realized via a tiny bash script on Linux, or bat file on Windows, which will launch
439+
your main application (the rest of your application will not be in the path). If, for example, your runnable file is
440+
something like 'Zone.Kuiper.HelloWorld', you may set `StartCommand` simply to 'helloworld'.
439441

440-
On Windows, a different application is taken. The `SetupCommandPrompt` is a Windows only option which ensures that a
442+
On Windows, a different approach is taken. The `SetupCommandPrompt` is a Windows only option which ensures that a
441443
Console entry is written to the Program Files menu (using the title you supply) which, when launched, will open a
442-
dedicated command window with your application directory in the user path.
444+
dedicated command window with your application directory in the path for the session.
443445

444446

445447
### Custom Post-Publish Operations <a name="custom-post-publish-operations"/>
@@ -517,7 +519,7 @@ https://learn.microsoft.com/en-us/dotnet/core/install/linux-scripted-manual#rpm-
517519

518520
From PupNet version 1.3.0 onward, the pupnet.conf file supports the ability to define such additional dependencies
519521
using the `RpmRequires` and `DebRecommends` properties. By default, they are populated with typically expected values
520-
(below), although these may be subject to change and you should review them for you application.
522+
(below), although these may be subject to change and you should review them for your application.
521523

522524
RpmRequires = """
523525
krb5-libs
@@ -703,8 +705,8 @@ This creates not only the `pupnet.conf` file, but the `.desktop` and a `.metainf
703705
Where possible, new versions of PupNet will be backward compatible with existing pupnet.conf files. If ever this
704706
is not the case, it will be explicitly stated.
705707

706-
New configuration properties may be added and old ones removed or deprecated. Where a new PupNet version results in
707-
changes to configuration properties, you can upgrade an existing pupnet.conf file to the latest format using:
708+
New configuration properties may be added and old ones removed or deprecated, however. Where a new PupNet version results
709+
in changes to configuration properties, you can upgrade an existing pupnet.conf file to the latest format using:
708710

709711
pupnet [file.pupnet.conf] --upgrade-conf
710712

@@ -715,14 +717,14 @@ or
715717
Your existing file will "backed-up" by appending an ".old" extension, and a new file written containing new properties
716718
with their default values.
717719

718-
Using the --verbose option (above), causes the new file to contain extensive document comments. Without it, the new file
720+
Using the `--verbose` option (above), causes the new file to contain extensive document comments. Without it, the new file
719721
will be stripped of comments.
720722

721723
See also version specific changes below.
722724

723725
### Version 1.4 Changes <a name="version-1.4-changes"/>
724726

725-
PupNet version 1.4 introduced new `AppDescription` and `AppChangeFile` configuration properties. If you wish to
727+
PupNet version 1.4.0 introduced new `AppDescription` and `AppChangeFile` configuration properties. If you wish to
726728
make use of them, populate `AppDescription` with a longer application description (example below), and point `AppChangeFile`
727729
to a changelog or README file containing formatted version information.
728730

@@ -748,16 +750,16 @@ make use of these new features:
748750
${APPSTREAM_DESCRIPTION_XML}
749751
</description>
750752

751-
Here, you may replace your default description text, but keep any other language text.
752-
753+
Here, you may replace your default description text, but keep any other language text. And:
753754

754755
<releases>
755756
${APPSTREAM_CHANGELOG_XML}
756757
</releases>
757758

758-
With this, you should remove existing version release information.
759+
With this one, you should remove existing version release information if ${APPSTREAM_CHANGELOG_XML} is going to be
760+
populated from `AppChangeFile`.
759761

760-
In addition to AppStream metadata, the `AppDescription` content is also now used in the construction of RPM and DEB
762+
In addition to AppStream metadata, the `AppDescription` content is now also used in the construction of RPM and DEB
761763
packages.
762764

763765

@@ -1327,13 +1329,13 @@ You may notice that PupNet outputs differences in package naming styles. For exa
13271329
PupNet-Deploy.x86_64.AppImage
13281330
pupnet-deploy_0.0.1-1_amd64.deb
13291331

1330-
PupNet follows the naming conventions used with the respective packages. This includes different CPU architecture
1331-
naming conventions.
1332+
PupNet follows the naming conventions used with the respective packages. This includes, for example, different CPU
1333+
architecture naming conventions. In some, it normal to include the version in the file, but not in others.
13321334

13331335
### RPM & Debian Packages Cannot be Removed using Gnome Software Center <a name="rpm-debian-packages-cannot-be-removed-using-gnome-software-center"/>
13341336

13351337
If you install your RPM and DEB packages from a local file (rather than a repository) they will, courtesy of your
1336-
AppStream metadata, show up in the Gnome Software Center GUI, as expected. However, you may find that they cannot be
1338+
AppStream metadata, show up in the Gnome Software Center, as expected. However, you may find that they cannot be
13371339
launched or removed using the GUI.
13381340

13391341
Instead, they must be removed from the command line, like so:
@@ -1344,8 +1346,8 @@ or:
13441346

13451347
sudo dnf remove helloworld
13461348

1347-
This is not an issue with PupNet or AppStream metadata. Rather, having been installed from file,
1348-
the Gnome Software Center lacks certain other metadata it expects had the package originated from a repository.
1349+
This is not an issue with PupNet or AppStream metadata. Rather, having been installed from file, the Gnome Software Center
1350+
lacks certain other metadata it expects had the package originated from a repository.
13491351
See [here for information](https://discourse.gnome.org/t/gnome-software-open-and-uninstall-button-not-working-for-app/14338/7).
13501352

13511353

@@ -1370,18 +1372,18 @@ In the process, however, I had cause to reflect on certain things, including the
13701372
because I intended to use Flatpak to deploy my other [application project](https://github.com/kuiperzone/AvantGarde),
13711373
but found that there are several important scenarios which Flatpak cannot support, including the deployment of development
13721374
tools. Regardless, I still thought it useful for developers to be able ship software in formats convenient for users,
1373-
so I added Flatpak to PupNet. However, I took out my anger by adding RPM and Debian formats as well.
1375+
so I added Flatpak to PupNet. However, I took out my anger by adding RPM and Debian formats in order to provide alternatives.
13741376

1375-
I would not be keen on adding more formats in the Linux space, as each deployment option must be maintained. Rather, I
1376-
would be interested to see how things play out in the future, especially with regard Snap packages. I note also the
1377-
trend toward centralized repository-only distribution models. For example, here is a quote from the
1377+
I would not be keen on adding more formats in the Linux space, however, as each deployment option must be maintained.
1378+
Rather, I would be interested to see how things play out in the future, especially with regard Snap packages. I note also
1379+
the trend toward centralized repository-only distribution models. For example, here is a quote from the
13781380
[Gnome Team](https://discourse.gnome.org/t/gnome-software-open-and-uninstall-button-not-working-for-app/14338/7):
13791381

13801382
*Stand-alone RPM files are really not a use case we want to encourage people to use.*
13811383

13821384
Repository only installations is not a paradigm I am fully onboard with, although I recognize its advantages. Rather,
1383-
I support the idea of freedom and that means developers and users having the freedom to create and share software without
1384-
necessarily having to go through third-parties who may act as gate-keepers.
1385+
I support the idea of freedom and that means developers and users having the freedom to create and share software themselves,
1386+
without necessarily having to go through third-parties who may act as gate-keepers.
13851387

13861388
This is why I support [AppImage](https://github.com/AppImage/AppImageKit) as a means of software distribution on Linux,
13871389
as it always best to keep the choice!

0 commit comments

Comments
 (0)