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