summaryrefslogtreecommitdiffstats
path: root/doc/life-cycles/README.md
blob: e65c3d3435fc0aa7262ad3d06e85fedc6d8971ae (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
Algorithm Life-Cycle Diagrams
=============================

This directory contains the algorithm life-cycle diagram sources.

The canonical life-cycles are in the spreadsheet.

The various .dot files are graph descriptions for the
[GraphViz](https://www.graphviz.org/) tool.  These omit edges and should
be used for guidance only.

To generate the rendered images, you need to install the following packages:

    sudo apt install graphviz cpanminus
    sudo cpanm Graph::Easy

Running `make` will produce a number of `.txt` and `.png` files.
These are the rendered `.dot` files.  The `.txt` files require
additional editing before they can be added to the manual pages in
`internal/man7/life_cycle-*.pod`.