summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/dbshow/README.md
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2022-01-14 22:37:24 +0000
committerKarl Berry <karl@freefriends.org>2022-01-14 22:37:24 +0000
commitdf3e7da4a19a19faec6c43c91dc6fb9b3e3fa20a (patch)
tree2c60f03e8c3d141ca91b42082361fac36cb8041e /Master/texmf-dist/doc/latex/dbshow/README.md
parentac081f6b6463c402084fb564b12b68890efd524b (diff)
dbshow (14jan22)
git-svn-id: svn://tug.org/texlive/trunk@61605 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/dbshow/README.md')
-rw-r--r--Master/texmf-dist/doc/latex/dbshow/README.md75
1 files changed, 57 insertions, 18 deletions
diff --git a/Master/texmf-dist/doc/latex/dbshow/README.md b/Master/texmf-dist/doc/latex/dbshow/README.md
index f91034d6cba..940f8ce35b8 100644
--- a/Master/texmf-dist/doc/latex/dbshow/README.md
+++ b/Master/texmf-dist/doc/latex/dbshow/README.md
@@ -1,32 +1,71 @@
+Package dbshow
+==============
-# Package dbshow
-
-## Overview
+Introduction
+------------
The package provides four core functions:
-1. data storage and display
+1. data storage
2. data filtering
3. data sorting
4. data display
-All data is saved once and then you can display these data with custom filters, orders and styles. The package can be used, for example, to record and display something you'd like to review, maybe the question you always answered incorrectly or some forgettable knowledge. But obviously, the package is much more powerful and extensible for more interesting tasks depending on the individual.
+All data is saved once and then you can display these data with custom filters,
+orders and styles. The package can be used, for example, to record and
+display something you'd like to review, maybe the question you always answered
+incorrectly or some forgettable knowledge. But obviously, the package is much
+more powerful and extensible for more interesting tasks depending on the
+individual.
+
+Install
+-------
+
+If you are using TeX Live, install `dbshow` by `tlmgr` package manager
+
+ tlmgr update --self --all
+ tlmgr install dbshow
+
+You can also download the zip file from
+[CTAN](https://ctan.org/pkg/dbshow) or
+[GitHub](https://github.com/ZhiyuanLck/dbshow/releases/latest).
+
+The zip file should contain the file `dbshow.dtx`, and you can extract
+`dbshow.sty` from it by
+
+ tex dbshow.dtx
+
+Compile Document
+----------------
+
+Use following commands to compile the document:
+
+ git clone https://github.com/ZhiyuanLck/dbshow.git
+ cd dbshow
+ latexmk dbshow.dtx
-## LICENSE
+Copyright and License
+---------------------
- dbshow.sty
- Copyright 2022 Li Changkai <lichangkai225@qq.com>
+ Copyright (C) 2022- by Changkai Li <lichangkai225@qq.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 may be distributed and/or modified under the
+ conditions of the LaTeX Project Public License, either
+ version 1.3c of this license or (at your option) any later
+ version. This version of this license is in
+ http://www.latex-project.org/lppl/lppl-1-3c.txt
+ and 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'.
+ This work has the LPPL maintenance status "maintained".
-The Current Maintainer of this work is Li Changkai.
+ The Current Maintainer of this work is Changkai Li.
-This work consists of the files dbshow.sty, dbshow-doc.tex.
+ This package consists of the file dbshow.dtx,
+ and the derived files dbshow.pdf,
+ dbshow.sty,
+ dbshow.ins and
+ README.md (this file).