summaryrefslogtreecommitdiffstats
path: root/doc/life-cycles
diff options
context:
space:
mode:
authorRich Salz <rsalz@akamai.com>2021-05-25 10:28:49 -0400
committerRichard Levitte <levitte@openssl.org>2021-05-28 11:14:46 +0200
commit3e3ad3c54855dd534437871a0c78858de5e3d246 (patch)
tree1d1264ae5d07caecefec35a26e3d751f27918390 /doc/life-cycles
parent32075a17249636b3e2986a0ac422b1803663ccaa (diff)
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)
Diffstat (limited to 'doc/life-cycles')
-rw-r--r--doc/life-cycles/README.md12
1 files changed, 7 insertions, 5 deletions
diff --git a/doc/life-cycles/README.md b/doc/life-cycles/README.md
index d504396545..e65c3d3435 100644
--- a/doc/life-cycles/README.md
+++ b/doc/life-cycles/README.md
@@ -1,3 +1,6 @@
+Algorithm Life-Cycle Diagrams
+=============================
+
This directory contains the algorithm life-cycle diagram sources.
The canonical life-cycles are in the spreadsheet.
@@ -6,11 +9,10 @@ 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:
-``` sh
-sudo apt install graphviz cpanminus
-sudo cpanm Graph::Easy
-```
+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