Debian Codegraph @

texmf-dist/doc/latex/char2path/README.md

raw
1 [![CTAN Version](https://img.shields.io/ctan/v/char2path)](https://ctan.org/pkg/char2path)
2 [![GitHub Release](https://img.shields.io/github/v/release/zongpingding/char2path)](https://github.com/zongpingding/char2path/releases/latest)
3 [![GitHub Last Commit](https://img.shields.io/github/last-commit/zongpingding/char2path)](https://github.com/zongpingding/char2path/commits)
4 [![Actions Status](https://github.com/zongpingding/char2path/actions/workflows/main.yaml/badge.svg?branch=main)](https://github.com/zongpingding/char2path/actions)
5 [![GitHub Repo stars](https://img.shields.io/github/stars/zongpingding/char2path)](https://github.com/zongpingding/char2path)
6
7 The `char2path` Package
8 =======================
9
10 The `char2path` package provides a LaTeX package for converting characters into TikZ paths.
11
12 Overview
13 --------
14
15 The package provides the `\chartopath` and `\chartoclip` macro
16
17 \chartopath [<keys>] {<string>}
18 \chartoclip [<keys>] {<string>}
19
20 to print Ti*k*Z paths for characters in a string.
21
22 See `char2path.pdf` for more. Happy TeXing!
23
24 Generate `tikz path` from font
25 ---
26 First, install the dependencies:
27 ```shell
28 cd resources/SVG/font2svg
29 pip install -r requirements.txt
30 ```
31
32 Next, define the following constants:
33 ```python
34 FONT_FOLDER = "../../Fonts/"
35 FONT_NAME = "lmmono10-regular.otf"
36 FONT_ALIAS = 'lmm'
37 ```
38
39 Finally, run the Python script below:
40 ``` shell
41 python font2path.py
42 ```
43
44 Issues
45 ------
46
47 The issue tracker for `char2path` is currently located
48 [on GitHub](https://github.com/zongpingding/char2path/issues).
49
50 Build status
51 ------------
52
53 This project uses [GitHub Actions](https://github.com/features/actions)
54 as a hosted continuous integration service. For each commit, the build status
55 is tested using the current release of TeX Live.
56
57 _Current build status:_ ![build status](https://github.com/zongpingding/char2path/actions/workflows/main.yaml/badge.svg?branch=main)
58
59 References
60 ----------
61
62 \[1\] https://www.gust.org.pl/projects/e-foundry/latin-modern/download
63
64 \[2\] https://www.unicode.org/standard/standard.html
65
66 Copyright and License
67 ---------------------
68
69 Copyright (C) 2023-2025 by zongpingding <[[email protected]](mailto:[email protected])> and
70 Mingyu Xia <[[email protected]](mailto:[email protected])>
71
72 This package's data is converted from
73 [Latin Modern family](https://www.gust.org.pl/projects/e-foundry/latin-modern),
74 which is based on the Computer Modern fonts released into public domain by
75 AMS (1997). It's under the license of
76 **[The GUS Font License (GFL)](https://ctan.org/license/gfl)**.
77
78 This work may be distributed and/or modified under the conditions
79 of the LaTeX Project Public License (LPPL), either version 1.3c of
80 this license or (at your option) any later version.
81 The latest version of this license is in
82
83 http://www.latex-project.org/lppl.txt
84
85 and version 1.3c or later is part of all distributions of LaTeX
86 version 2008 or later.
87
88 This work has the LPPL maintenance status `maintained'.
89
90 The Current Maintainer of this work is **zongpingding** and **Mingyu Xia**.