https://github.com/9999years/latex-changelog

LaTeX package for typesetting changelogs
https://github.com/9999years/latex-changelog

Last synced: 29 days ago
JSON representation

LaTeX package for typesetting changelogs

• Host: GitHub
• URL: https://github.com/9999years/latex-changelog
• Owner: 9999years
• License: lppl-1.3c
• Created: 2018-10-26T18:53:40.000Z (about 6 years ago)
• Default Branch: main
• Last Pushed: 2024-10-03T16:41:43.000Z (3 months ago)
• Last Synced: 2024-10-24T03:36:08.365Z (3 months ago)
• Language: TeX
• Homepage: https://ctan.org/pkg/changelog
• Size: 171 KB
• Stars: 8
• Watchers: 3
• Forks: 3
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# The `changelog` LaTeX package

[Available on CTAN as `changelog`][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

changelog.pdf                | Documentation (English)

changelog.tex                | Documentation source

example.tex                  | Example use

example.pdf                  | Example use (PDF)

screenshot.png               | Sample screenshot

README.md                    | This file

LICENSE.txt                  | LPPL v1.3c

## Development

Sources for this package are [available on GitHub.][github]

This package is built with the [Nix][nix] package manager.

- Build a release directory with rendered PDFs:

  `nix build .#changelog`

- Build a release tarball:

  `nix build .#changelog-tar`, or just `nix build`

- Enter a development shell with `latexmk` and fonts available:

  `nix develop`

[keepachangelog.com]: https://keepachangelog.com/

[changelog]: https://ctan.org/pkg/changelog

[github]: https://github.com/9999years/latex-changelog

[nix]: https://zero-to-nix.com/