summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/README.md
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2021-03-22 16:42:36 +0000
committerKarl Berry <karl@freefriends.org>2021-03-22 16:42:36 +0000
commitbb9c3c67d0b2374807fce790b41ffd4c6783fb64 (patch)
tree2e3f8fd9354e74892d32c8ab0e8ee38e5132e748 /Master/texmf-dist/README.md
parent4c0fa54077a5924bc937894d78827ac320e4a37f (diff)
hyph-utf8 update from arthur
git-svn-id: svn://tug.org/texlive/trunk@58619 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/README.md')
-rw-r--r--Master/texmf-dist/README.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/Master/texmf-dist/README.md b/Master/texmf-dist/README.md
new file mode 100644
index 00000000000..3c498767218
--- /dev/null
+++ b/Master/texmf-dist/README.md
@@ -0,0 +1,24 @@
+[![Build Status](https://travis-ci.com/hyphenation/tex-hyphen.svg?branch=master)](https://travis-ci.com/hyphenation/tex-hyphen)
+
+This is the central repository for all hyphenation patterns (that we know of).
+These patterns are encoded in UTF-8, but can also be used with 8-bit TeX
+engines such as pdfTeX with the help of mechanisms provided with the package.
+It is meant to be a low-level package and is integrated with all major TeX
+distributions (TeX Live, MiKTeX, W32TeX); most TeX users should thus not
+concern themselves with this package, unless of course they’re working on the
+hyphenation patterns themselves.
+
+We upload the package to CTAN regularly and use git tags to identify versions;
+a CTAN upload has a version date in the form `yyyy-mm-dd`, corresponding to tag
+`CTAN-yyyy.mm.dd` in this git repository. Because the package contains
+contributions from many different sources that are not updated at the same
+time, we felt this was this best choice for version identifiers.
+
+If you are an author of hyphenation patterns and want to add or update them,
+please contact the maintainers through the mailing list: tex-hyphen@tug.org
+You can also visit the [TeX hyphenation page](http://www.hyphenation.org/tex) for more
+information and technical details.
+
+# Running
+`bundle` (or `bundle install`)
+`bundle exec rake` runs the default task in the Rakefile.