summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2023-04-02 20:33:31 +0000
committerKarl Berry <karl@freefriends.org>2023-04-02 20:33:31 +0000
commitc33f6d2978cfd4321977ffde5d61bdde135b2554 (patch)
tree2c17755540a6271ecbff81e5e5e72cfa88a75cea /Master/texmf-dist/doc
parentbefed19f1211eb1d625e1507ca7de72cec7d8814 (diff)
findpkg (2apr23)
git-svn-id: svn://tug.org/texlive/trunk@66743 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc')
-rw-r--r--Master/texmf-dist/doc/support/findpkg/README.md28
1 files changed, 28 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/support/findpkg/README.md b/Master/texmf-dist/doc/support/findpkg/README.md
new file mode 100644
index 00000000000..3f3522f5296
--- /dev/null
+++ b/Master/texmf-dist/doc/support/findpkg/README.md
@@ -0,0 +1,28 @@
+# FindPkg tool for installing TeX packages
+
+```
+Description: Install TeX packages and their dependencies
+Copyright: 2023 (c) Jianrui Lyu <tolvjr@163.com>
+Repository: https://github.com/lvjr/findpkg
+License: GNU General Public License v3.0
+```
+
+## Introduction
+
+FindPkg makes it easy to install TeX packages and their dependencies by file names, command names or environment names.
+
+- To install a package by its file name you can run `texlua findpkg.lua install array.sty`;
+- To install a package by some command name you can run `texlua findpkg.lua install \fakeverb`;
+- To install a package by some environment name you can run `texlua findpkg.lua install {frame}`.
+
+FindPkg supports both TeXLive and MiKTeX distributions. At present it focuses mainly on LaTeX packages, but may extend to ConTeXt packages if anyone would like to contribute.
+
+## Building
+
+FindPkg uses completion files of TeXstudio editor which are in `completion` folder of TeXstudio [repository](https://github.com/texstudio-org/texstudio).
+
+After putting `completion` folder into current folder, you can run `texlua findpkg.lua generate` to generate `findpkg.json` file.
+
+## Contributing
+
+Any updates of dependencies, commands or environments for packages should be contributed directly to TeXstudio project.