README

                             zhmakeindex
                             ===========

Zhmakeindex is a makeindex replacement for Chinese users, with full Unicode
and Chinese sorting support.

REQUIREMENTS
============

Zhmakeindex is written in Google Go language, released with statically linked
binary code.

Zhmakeindex can be run everywhere without any dependency library. However, a
modern Web2c TeX distribution (TeX Live, MiKTeX) is recommended to use
zhmakeindex, and the style file searching faculty needs `kpsewhich' command.

To compile zhmakeindex, the latest Go language is needed:

    http://golang.org/

And zhmakeindex is compiled using these Go packages:

  * golang.org/x/text
  * github.com/yasushi-saito/rbtree

DOCUMENTATION AND SUPPORT
=========================

The documentation of zhmakeindex is in Chinese only.

After installing, `zhmakeindex -help' will provide a basic documentation.
The PDF documentation is also available for details.

More information, bugfix releases and bug tracker are available at:

    https://github.com/leo-liu/zhmakeindex

COPYRIGHT AND LICENCE
=====================

Copyright 2014, 2015, 2016, 2018 Liú Hǎiyáng (Leo Liu) <leoliu.pku@gmail.com>

This work may be distributed and/or modified under the
conditions of the LaTeX Project Public License, either version 1.3
of this license or (at your option) any later version.
The latest version of this license is in
  http://www.latex-project.org/lppl.txt
and version 1.3 or later is part of all distributions of LaTeX
version 2005/12/01 or later.

This work has the LPPL maintenance status `maintained'.

The Current Maintainer of this work is Liú Hǎiyáng.