summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/circledsteps/README.md
blob: 42551b8b5f2fecc96b16db512c7f0932a8ca7b81 (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
## Package `circledsteps` for LaTeX

A package to generate circled numbers (or other kind of markers or small text) to mark "steps" in procedure, exercises, and so on.

See [this question on tex.stackexchange.com](https://tex.stackexchange.com/questions/7032/good-way-to-make-textcircled-numbers)

### DOCUMENTATION

See the included file `circledsteps-manual.tex`; you can compile it running (twice) `pdflatex` on it. If you want to have a look before buying, you can find a compiled copy on the [release page](https://github.com/Rmano/circledsteps/releases) or on [CTAN](https://ctan.org/pkg/circledsteps).

If you have already installed the package in your TeX distribution, use `texdoc circledsteps`; it should show you the manual of the installed version of the package.


### LICENSE

Licensed under [LPPL 1.3c](https://www.latex-project.org/lppl/lppl-1-3c/)

### SOURCE REPO

The source is hosted on [GitHub](https://github.com/Rmano/circledsteps).
If you clone the repository, you can use

    make local-install

to install the package on [your local TEXMF tree](https://tex.stackexchange.com/questions/1137/where-do-i-place-my-own-sty-or-cls-files-to-make-them-available-to-all-my-te).

To compile the documentation from the source code repository you need to have `latexmk` installed (it is *not* needed to use the package, though.)