xref: /freebsd/crypto/openssl/doc/life-cycles/README.md (revision 02e9120893770924227138ba49df1edb3896112a)
1Algorithm Life-Cycle Diagrams
2=============================
3
4This directory contains the algorithm life-cycle diagram sources.
5
6The canonical life-cycles are in the spreadsheet.
7
8The various .dot files are graph descriptions for the
9[GraphViz](https://www.graphviz.org/) tool.  These omit edges and should
10be used for guidance only.
11
12To generate the rendered images, you need to install the following packages:
13
14    sudo apt install graphviz cpanminus
15    sudo cpanm Graph::Easy
16
17Running `make` will produce a number of `.txt` and `.png` files.
18These are the rendered `.dot` files.  The `.txt` files require
19additional editing before they can be added to the manual pages in
20`internal/man7/life_cycle-*.pod`.
21