summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/codebox/README.md
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2021-12-26 21:24:12 +0000
committerKarl Berry <karl@freefriends.org>2021-12-26 21:24:12 +0000
commit75d213e27f886527da7f88c613f9aa4860332753 (patch)
treedb543cd6fb662dc5a6fae95a12a74560b3c691cd /Master/texmf-dist/doc/latex/codebox/README.md
parentb21cfe3d39f2f88863c9cb3e0f4c64bb44dc13f1 (diff)
codebox (26dec21)
git-svn-id: svn://tug.org/texlive/trunk@61415 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/codebox/README.md')
-rw-r--r--Master/texmf-dist/doc/latex/codebox/README.md68
1 files changed, 68 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/latex/codebox/README.md b/Master/texmf-dist/doc/latex/codebox/README.md
new file mode 100644
index 00000000000..f5372b8900a
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/codebox/README.md
@@ -0,0 +1,68 @@
+Create code box and viewer based on tcolorbox and minted/listings
+=======
+
+`codebox` is a LaTeX3 package developed based on tcolorbox and minted/listings, which provides environments `codebox` and `codeview` to typset with environment body, and macros `\codefile` and `\cvfile` to typeset programming source code from a file in a fancy box.
+
+The starred version of all environments and macros are provided at the same time, such as `codebox*`, `codeview*`, `\codefile*` and `\cvfile*` which adds comment at bottom of the fancy box.
+
+You can read the manual (in Chinese/English) for more details and examples.
+
+Contributing
+------------
+
+1. github repository:
+ 1. repository: [codebox](https://github.com/registor/codebox)
+ 2. Issues and pull requests are welcome. [issue](https://github.com/registor/codebox/issues) or [pull request](https://github.com/registor/codebox/pulls).
+
+2. gitee repository:
+ 1. repository: [codebox](https://gitee.com/nwafu_nan/codebox)
+ 2. Issues and pull requests are welcome. [issue](https://gitee.com/nwafu_nan/codebox/issues) or [pull request](https://gitee.com/nwafu_nan/codebox/pulls).
+
+基于tcolorbox的终端模拟宏包
+=======
+
+`codebox`是一个基于tcolorbox的用LaTeX3开发的终端模拟LaTeX宏包,它提供了用于排版程序源代码盒子的环境和命令。
+
+其中`codebox`和`codeview`环境用于根据环境内容排版代码,`\codefile`和`\cvfile`命令用于根据文件内容排版代码。
+
+`codebox`同时提供了各环境和命令的星号版本,如`codebox*`和`codeview*`,`\codefile*`和`\cvfile*`,用于为代码盒子添加底线注释。
+
+可以通过阅读宏包手册(中文/英文)以也解该宏包更多的使用细节和使用样例。
+
+### 参与贡献
+---------------------
+
+1. github仓库:
+ (1). 仓库地址: [codebox](https://github.com/registor/codebox)
+ (2). Issues和PR: [issue](https://github.com/registor/codebox/issues) or [pull request](https://github.com/registor/codebox/pulls).
+
+2. gitee仓库:
+ (1). 仓库地址: [codebox](https://gitee.com/nwafu_nan/codebox)
+ (2). Issues and PR: [issue](https://gitee.com/nwafu_nan/codebox/issues) or [pull request](https://gitee.com/nwafu_nan/codebox/pulls).
+
+Copyright and Licence
+---------------------
+
+ Copyright (C) 2020-2021 by Nan Geng <nangeng@nwafu.edu.cn>
+ ----------------------------------------------------------------------
+
+ 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".
+
+ The Current Maintainer of this work is Nan Geng.
+
+ This package consists of the file codebox.dtx,
+ and the derived files codebox.sty,
+ codebox.pdf,
+ codebox.ins,
+ README.md (this file).
+