summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJehan <jehan@girinstud.io>2022-12-08 22:32:56 +0100
committerJehan <jehan@girinstud.io>2022-12-08 22:34:22 +0100
commit2f5c24006ebc7f005040358f58f22a61a3c92522 (patch)
treeb99b74a257e117bdf8054f1330dcd27a0a829d0a
parentae6302a016088ad07177f86d417b20010053632b (diff)
README, doc: some README and release procedure updates.
-rw-r--r--README.md6
-rw-r--r--doc/README.maintainer16
2 files changed, 13 insertions, 9 deletions
diff --git a/README.md b/README.md
index f6a7424..f96f489 100644
--- a/README.md
+++ b/README.md
@@ -183,7 +183,7 @@ uchardet started as a C language binding of the original C++ implementation of t
### Mac
brew install uchardet
-
+
or
port install uchardet
@@ -300,8 +300,8 @@ It is to be noted that a lot has changed since the original code, yet
the base concept is still around, basing detection not just on encoding
rules, but importantly on analysis of character statistics in languages.
-Original code by Mozilla does not seem to be found anymore anywhere, but
-it's probably not too far from the initial commit of this repository.
+Original code of `universalchardet` by Mozilla can still be retrieved from the
+[Wayback machine](https://web.archive.org/web/20150730144356/http://lxr.mozilla.org/seamonkey/source/extensions/universalchardet/).
Mozilla code was extracted and packaged into a standalone library under
the name `uchardet` by BYVoid in 2011, in a personal repository.
diff --git a/doc/README.maintainer b/doc/README.maintainer
index 4577615..a3c43ab 100644
--- a/doc/README.maintainer
+++ b/doc/README.maintainer
@@ -7,9 +7,13 @@
* Commit the version change with the message "Release: version X.Y.Z."
-* Tag your release commit with:
+* In the next commands, let's suppose such environment variable is set:
- git tag -a vx.y.z
+ export UCHARDET_VERSION=x.y.z
+
+* Tag and sign your release commit with:
+
+ git tag -s v$UCHARDET_VERSION
The tag message should be have the header "Version x.y.z released." followed
by a list of new features or important fixes. This tag message will be
@@ -25,11 +29,11 @@
* Push the release and the tag:
git push
- git push origin vx.y.z
+ git push origin v$UCHARDET_VERSION
* Create a release tarball:
- git archive --format=tar.xz --prefix=uchardet-x.y.z/ vx.y.z >uchardet-x.y.z.tar.xz
+ git archive --format=tar.xz --prefix=uchardet-$UCHARDET_VERSION/ v$UCHARDET_VERSION >uchardet-$UCHARDET_VERSION.tar.xz
Note: if you have not already set this up, you have to run first:
@@ -39,11 +43,11 @@ Cf. EXAMPLES section in `git help archive`.
* Compute a SHA1 checksum:
- sha1sum uchardet-x.y.x.tar.xz > uchardet-x.y.z.tar.xz.sha1
+ sha256sum uchardet-$UCHARDET_VERSION.tar.xz > uchardet-$UCHARDET_VERSION.tar.xz.sha256
* Upload to annarchy download server:
- scp uchardet-x.y.x.tar.xz uchardet-x.y.z.tar.xz.sha1 annarchy.freedesktop.org:/srv/www.freedesktop.org/www/software/uchardet/releases/
+ scp uchardet-$UCHARDET_VERSION.tar.xz uchardet-$UCHARDET_VERSION.tar.xz.sha256 annarchy.freedesktop.org:/srv/www.freedesktop.org/www/software/uchardet/releases/
The archive and its checksum file should now be available from:
https://www.freedesktop.org/software/uchardet/releases/