diff options
author | Karl Berry <karl@freefriends.org> | 2018-10-28 21:06:14 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2018-10-28 21:06:14 +0000 |
commit | 4d1fe1c455eecb0f6d8c7039a842e7e370b6d09d (patch) | |
tree | 2f5cb5162fbe4d973c34c95d500018764ef8f6c2 /Master/texmf-dist/doc/latex/changelog/README.md | |
parent | 8331a2748eb053e4c45a82481aa41ef22c44fb42 (diff) |
changelog (28oct18)
git-svn-id: svn://tug.org/texlive/trunk@49012 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/changelog/README.md')
-rw-r--r-- | Master/texmf-dist/doc/latex/changelog/README.md | 50 |
1 files changed, 50 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/latex/changelog/README.md b/Master/texmf-dist/doc/latex/changelog/README.md new file mode 100644 index 00000000000..017eaafebe6 --- /dev/null +++ b/Master/texmf-dist/doc/latex/changelog/README.md @@ -0,0 +1,50 @@ +# The `changelog` LaTeX package + +Changelogs are important. Unfortunately, there are few facilities +for typesetting changelogs in LaTeX. `changelog` defines a `changelog` +environment to make changelogs simple and intuitive. + +Inspired by [keepachangelog.com]. + +File | Description +-----------------------------|------------------------------- +changelog.sty | The brandeis-problemset document class +changelog.pdf | Documentation (English) +changelog.tex | Documentation source +changelog-doc.sty | Documentation styles +README.md | This file +LICENSE.md | GNU GPLv3 + +## Example + + \begin{changelog}[author=Rebecca Turner] + \begin{version} + \added Really cool features + \end{version} + + \begin{version}[date=2019-01-23] + \item A version with only a date + \end{version} + + \begin{version}[v=1.1.0] + \item A version with no date + \end{version} + + \begin{version}[v=1.0.1, yanked] + \item A version with a terrible bug + \end{version} + + \begin{version}[v=1.0.0, date=2018-10-26] + \added a cool feature + \changed some \textsc{api} detail + \deprecated something that was a bad idea in the first place + \removed something that was deprecated 3 versions ago + \fixed a bug that would delete files instead of saving them + \security improved with addition of buffer bound checks + \item A change that doesn't fit into any other category + \end{version} + \shortversion{v=0.1.0, date=2018-10-19, + changes=Initial beta.} + \end{changelog} + +[keepachangelog.com]: https://keepachangelog.com/ |