aboutsummaryrefslogtreecommitdiff
path: root/doc/packaging.cli
diff options
context:
space:
mode:
authorBoris Kolpackov <boris@codesynthesis.com>2024-02-15 07:11:15 +0200
committerBoris Kolpackov <boris@codesynthesis.com>2024-02-15 07:11:15 +0200
commitd2e0592a126a9d454d7cf00b467433d107a1533d (patch)
tree319757935652bf5618a0b984d88592499f24f760 /doc/packaging.cli
parentbb0e1df9ac453b90cb05a115f0a937ba34a677cd (diff)
Further work on packaging guide
Diffstat (limited to 'doc/packaging.cli')
-rw-r--r--doc/packaging.cli12
1 files changed, 11 insertions, 1 deletions
diff --git a/doc/packaging.cli b/doc/packaging.cli
index 7f3603e..fcc0a7f 100644
--- a/doc/packaging.cli
+++ b/doc/packaging.cli
@@ -3264,7 +3264,17 @@ section.
Similarly, if the package has no configuration variables, then it makes sense
to drop the \"Configuration variables\" section.
-@@ Fix libeven, byacc/xxd PACKAGE-README.md and recomment for inspiration.
+For inspiration, see
+\l{https://github.com/build2-packaging/libevent/blob/main/PACKAGE-README.md
+\c{PACKAGE-README.md}} in \l{https://github.com/build2-packaging/libevent
+\c{libevent}} (library) and
+\l{https://github.com/build2-packaging/xxd/blob/master/xxd/README.md
+\c{README.md}} in \l{https://github.com/build2-packaging/xxd \c{xxd}}
+(executable).
+
+\N|If upstream does not provide a \c{README} file, then it makes sense to
+rename \c{PACKAGE-README.md} to just \c{README.md} in the \c{build2} package,
+as was done in \c{xxd} mentioned above.|
Once \c{PACKAGE-README.md} is ready, commit and push the changes. You may also
want to view the result on GitHub to make sure everything is rendered