| 1 |
# huffman |
| 2 |
|
| 3 |
This METAPOST package allows to draw binary Huffman trees from two |
| 4 |
arrays : a string one, and a value one. It is based on METAOBJ package which |
| 5 |
provides many tools to build trees in general. |
| 6 |
|
| 7 |
_This package is in beta version, do not hesitate to report bugs, as well as |
| 8 |
requests for improvement_. |
| 9 |
|
| 10 |
## Github |
| 11 |
|
| 12 |
To allow for easier feedback and bug reporting, this repository has a mirror |
| 13 |
repository on github: |
| 14 |
[https://github.com/chupinmaxime/huffman](https://github.com/chupinmaxime/huffman) |
| 15 |
|
| 16 |
## Installation |
| 17 |
|
| 18 |
huffman is on the [ctan](ctan.org) and can be installed via the package manager of your |
| 19 |
distribution [https://www.ctan.org/pkg/mpchess](https://www.ctan.org/pkg/huffman). |
| 20 |
|
| 21 |
### With TeX live under Linux or MacOS |
| 22 |
|
| 23 |
To install huffman with TeX live, you will have to create the directory texmf |
| 24 |
directory in your home. |
| 25 |
```bash |
| 26 |
user $> mkdir ~/texmf |
| 27 |
``` |
| 28 |
|
| 29 |
Then, you will have to place the .mp files in the |
| 30 |
`~/texmf/tex/metapost/huffman/`. |
| 31 |
|
| 32 |
Once this is done, huffman will be loaded with the classic |
| 33 |
```metapost |
| 34 |
input huffman |
| 35 |
``` |
| 36 |
|
| 37 |
### With MikTEX and Windows |
| 38 |
|
| 39 |
These two systems are unknown to the author of MPchess, so we refer to their |
| 40 |
documentation to add local packages: |
| 41 |
[http://docs.miktex.org/manual/localadditions.html](http://docs.miktex.org/manual/localadditions.html) |
| 42 |
|
| 43 |
## Dependencies |
| 44 |
|
| 45 |
huffman depends on the packages METAPOST: `metaobj` and, if MPchess is not |
| 46 |
used with LuaLaTeX and luamplib, `latexmp`. |
| 47 |
|
| 48 |
## Documentation |
| 49 |
|
| 50 |
* [English documentation](doc/huffman-doc-en.pdf) |
| 51 |
|
| 52 |
## Contact |
| 53 |
|
| 54 |
Maxime Chupin, `notezik(at)gmail.com` |
| 55 |
|
| 56 |
## Licenses |
| 57 |
|
| 58 |
This projet is under LATEX Project Public License 1.3c. |