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