diff options
Diffstat (limited to 'macros/latex/contrib/changelog/README.md')
-rw-r--r-- | macros/latex/contrib/changelog/README.md | 13 |
1 files changed, 11 insertions, 2 deletions
diff --git a/macros/latex/contrib/changelog/README.md b/macros/latex/contrib/changelog/README.md index ab16196d1e..6b7d251083 100644 --- a/macros/latex/contrib/changelog/README.md +++ b/macros/latex/contrib/changelog/README.md @@ -2,12 +2,21 @@ [Available on CTAN as `changelog`][changelog] -Changelogs are important. Unfortunately, there are few facilities -for typesetting changelogs in LaTeX. `changelog` defines a `changelog` +Changelogs are important. The `changelog` package defines a `changelog` environment to make changelogs simple and intuitive. Inspired by [keepachangelog.com]. +```latex +\begin{changelog}[author=Rebecca Turner, simple, sectioncmd=\section*] +\begin{version}[v=1.0.0, date=2018-12-28] + \item Cool features + \item Bug fixes +\end{version} +\shortversion{v=0.1.0, date=2018-10-25, changes=Initial beta} +\end{changelog} +``` + File | Description -----------------------------|------------------------------- changelog.sty | The changelog package |