openssl/doc/life-cycles/README.md
Rich Salz 3e3ad3c548 Fix issues found by md-nits
Fixes #15460

Reviewed-by: Shane Lontis <shane.lontis@oracle.com>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/15461)
2021-05-28 11:14:46 +02:00

21 lines
709 B
Markdown

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`.