summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/zhlipsum/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/latex/zhlipsum/README.md')
-rw-r--r--Master/texmf-dist/doc/latex/zhlipsum/README.md56
1 files changed, 40 insertions, 16 deletions
diff --git a/Master/texmf-dist/doc/latex/zhlipsum/README.md b/Master/texmf-dist/doc/latex/zhlipsum/README.md
index 97bd30b98b6..fd97171db25 100644
--- a/Master/texmf-dist/doc/latex/zhlipsum/README.md
+++ b/Master/texmf-dist/doc/latex/zhlipsum/README.md
@@ -1,29 +1,53 @@
-# zhlipsum - Chinese dummy text
+The `zhlipsum` package
+======================
-[![Build Status](https://travis-ci.org/Stone-Zeng/zhlipsum.svg?branch=master)](https://travis-ci.org/Stone-Zeng/zhlipsum)
-[![CTAN](https://img.shields.io/ctan/v/zhlipsum.svg)](https://www.ctan.org/pkg/zhlipsum)
-[![GitHub release](https://img.shields.io/github/release/Stone-Zeng/zhlipsum/all.svg)](https://github.com/Stone-Zeng/zhlipsum/releases/latest)
+The `zhlipsum` package provides an interface to dummy text in
+Chinese language, which will be useful for testing Chinese
+documents.
-## Introduction
+`zhlipsum` supports UTF-8, GBK and Big5 encodings.
-This pack­age pro­vides an in­ter­face to dummy text in Chi­nese, which
-will be use­ful for test­ing Chi­nese doc­u­ments.
+Basic usage
+-----------
-`zhlipsum` supports both UTF-8 and GBK en­cod­ing.
+ \zhlipsum
+ \zhlipsum*[1-5]
+ \zhlipsum[6-10][script=trad]
-## Basic usage
+More information can be found in the package documentation
+[zhlipsum.pdf](http://mirrors.ctan.org/macros/latex/contrib/zhlipsum/zhlipsum.pdf)
+(Chinese version) or [zhlipsum-en.pdf](http://mirrors.ctan.org/macros/latex/contrib/zhlipsum/zhlipsum-en.pdf)
+(English version).
-```tex
-\zhlipsum[3]
-\zhlipsum*[1-5]
-```
+Installation
+------------
-More information can be found in the package documentation
-[zhlipsum.pdf](http://mirrors.ctan.org/macros/latex/contrib/zhlipsum/zhlipsum.pdf).
+To install `zhlipsum`, you can use one of the following methods:
+
+- If you are running TeX Live, the simplest way is to run
+
+ tlmgr install zhlipsum
+
+- Download
+ [zhlipsum.tds.zip](http://mirror.ctan.org/install/macros/latex/contrib/zhlipsum.tds.zip)
+ from CTAN, extract it in the root of one of your TDS trees, and
+ update the filename database.
-## License
+Contributing
+------------
+
+[Issues](https://github.com/Stone-Zeng/zhlipsum/issues) and
+[pull requests](https://github.com/Stone-Zeng/zhlipsum/pulls)
+are always welcome.
+
+License
+-------
This work may be distributed and/or modified under the conditions of
the [LaTeX Project Public License](http://www.latex-project.org/lppl.txt),
either version 1.3c of this license or (at your option) any later
version.
+
+-----
+
+Copyright (C) 2017, 2018 by Xiangdong Zeng <pssysrq@163.com>.