summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorRuss Allbery <rra@cpan.org>2020-12-25 11:30:48 -0800
committerRuss Allbery <rra@cpan.org>2020-12-25 11:30:48 -0800
commit0647d9a0e6f2d8405bef658c919979b91fac9932 (patch)
tree9f9289db93a31e62763fc92861d40629a44ff9ac /README
parent1e538e2e09f0365d52e00924e548d5f177dc838d (diff)
Documentation updates for new features
Add App::DocKnot::Update to the API files, fix a bit more wording to reflect the new single metadata file layout, and add a note to the description that DocKnot generates distribution tarballs as well.
Diffstat (limited to 'README')
-rw-r--r--README6
1 files changed, 5 insertions, 1 deletions
diff --git a/README b/README
index cafbec9..1875f24 100644
--- a/README
+++ b/README
@@ -26,7 +26,7 @@ DESCRIPTION
version of README as well, avoiding the ugly text rendering on the
GitHub page for a package.
- This package uses one metadata directory as its source information and
+ This package uses one metadata file as its source information and
generates all the various bits of documentation for a package. This
allows me to make any changes in one place and then just regenerate the
web page, included documentation, and other files to incorporate those
@@ -34,6 +34,10 @@ DESCRIPTION
shared wording and push that out to every package I maintain during its
next release, without having to remember which changes I wanted to make.
+ DocKnot is also slowly absorbing other tools that I use for software
+ distribution and web site maintenance, such as generating distribution
+ tarballs for software packages.
+
DocKnot was designed and written for my personal needs, and I'm not sure
it will be useful for anyone else. At the least, the template files are
rather specific to my preferences about how to write package