summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/cryptocode/README.md
blob: 88105e4e27ab02ac32713415ab3407a43e816047 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
# Cryptocode
The cryptocode package provides a set of macros to ease the typesetting of pseudocode, algorithms and protocols. In addition it comes with a wide range of tools to typeset cryptographic papers. This includes simple predefined commands for concepts such as a security parameter or advantage terms but also flexible and powerful environments to layout game-based proofs or black-box reductions.

# Installation

Extract the *cryptocode.sty* file via

    pdflatex cryptocode.ins

# Documentation

Create the documentation via

    pdflatex cryptocode.dtx
    pdflatex cryptocode.dtx
    makeindex -s gind.ist -o cryptocode.idx cryptocode
    makeindex -s gglo.ist -o cryptocode.gls cryptocode.glo
    pdflatex cryptocode.dtx

A prebuilt version of the documentation is available in the repository.

# Versioning

Cryptocode supports LaTeX' rollback mechanism. To load a particular version of cryptocode use

    \usepackage[options]{cryptocode}[=2018-11-11]

Besides the current version 0.44, the following deprecated versions are available via
the rollback mechanism.

- v0.32 (2020-04-24)
- v0.30 (2018-11-11)

# Contribution

Contributions to *cryptocode* are very welcome. 

# Attribution

If you use cryptocode in your work, consider starring the repository on GitHub and/or rating it on CTAN.

# License

[LaTeX Project Public License](http://www.latex-project.org/lppl.txt)