Skip to content

Commit 6d7bd83

Browse files
committed
update README
1 parent 802013c commit 6d7bd83

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# Annotated example of how to make annotated equations in LaTeX using TikZ.
22

3-
## Work in progress: turning it into reusable commands
3+
## A package with reusable commands
44

55
![output of annotated equation](example_annotation_package.png)
66

7-
Using [`annotate_equations.sty`](https://github.com/st--/annotated_latex_equations/blob/main/annotate_equations.sty), an equation can easily be annotated as follows:
7+
Using [`annotate_equations.sty`](https://github.com/st--/annotate_equations/blob/main/annotate_equations.sty), an equation can easily be annotated as follows:
88
```latex
99
\begin{equation*}
1010
\mathcal{O}\big(
@@ -34,6 +34,9 @@ Using [`annotate_equations.sty`](https://github.com/st--/annotated_latex_equatio
3434
\annotate[yshift=-1em]{below}{M}{\# of samples for $\mathbb{E}_y$}
3535
```
3636

37+
More details are in the [user manual](usermanual.pdf).
38+
Should work with both pdflatex and lualatex.
39+
3740
## How to do it from scratch
3841

3942
![output of annotated equation](example_annotation.png)

0 commit comments

Comments
 (0)