Debian Codegraph @

texmf-dist/doc/metapost/wordcloud/README.md

raw
1 # wordcloud
2
3 This package (MetaPost, Lua, and LaTeX) allows you to draw wordclouds.
4
5 _This package is in beta version, do not hesitate to report bugs, as well as
6 requests for improvement. There is lots to do!_
7
8 ## Github
9
10 To allow for easier feedback and bug reporting, this repository has a mirror
11 repository on github:
12 [https://github.com/chupinmaxime/wordcloud](https://github.com/chupinmaxime/wordcloud)
13
14 ## Installation
15
16 Wordcloud is on the [ctan](ctan.org) and can be installed via the package manager of your
17 distribution [https://www.ctan.org/pkg/wordcloud](https://www.ctan.org/pkg/wordcloud).
18
19 ### With TeX live under Linux or MacOS
20
21 To install `wordcloud` with TeX live, you will have to create the directory `texmf`
22 directory in your home.
23 ```bash
24 user $> mkdir ~/texmf
25 ```
26
27 Then, you will have to place the .mp files in the
28 `~/texmf/tex/metapost/wordcloud/`.
29
30 `wordcloud` consists of 3 files:
31 * `wordcloud.mp` (MetaPost) that should be in `~/texmf/metapost/wordcloud/`;
32 * `wordcloud.tex` (LaTeX) that should be in `~/texmf/tex/latex/wordcloud/`;
33 * `wordcloud.lua` (Lua) that should be in `~/texmf/scripts/wordcloud/`.
34
35 ### With MikTEX and Windows
36
37 These two systems are unknown to the author of Wordcloud, so we refer to their
38 documentation to add local packages:
39 [http://docs.miktex.org/manual/localadditions.html](http://docs.miktex.org/manual/localadditions.html)
40
41 ## Dependencies
42
43 * metapost-colorbrewer
44 * latexmp
45 * luamplib
46 * xcolor
47 ## Documentation
48
49 * [English documentation](doc/wordcloud-doc-en.pdf)
50
51 ## Contact
52
53 Maxime Chupin, `notezik(at)gmail.com`
54
55 ## Licenses
56
57 This projet is under LATEX Project Public License 1.3c.