Skip to content

Commit

Permalink
add mdl and update installation instructions to pre-commit hook
Browse files Browse the repository at this point in the history
  • Loading branch information
TeXhackse committed Nov 17, 2024
1 parent ddb2b12 commit fb846c2
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 17 deletions.
18 changes: 11 additions & 7 deletions INSTALL.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,34 @@
# Installation

## Recommended setup
As this package is now released via CTAN, it's hightly recommended to use the TeX Live Manager for installation.

As this package is now released via CTAN, it's hightly recommended to use the TeX Live Manager (or the MikTeX console) for installation.

## Minimal portable TeX Live via DEPP

Additionally for it's possible to use the Island of TeX's DEPP project to create a minimal portable TeX Live installation only including the dependencies for this kind of documents.
This repository includes a DEPENDS.txt for this purpose.
Additionally for it's possible to use the Island of TeX's DEPP project to create a minimal portable TeX Live installation only including the dependencies for this kind of documents.
This repository includes a `DEPENDS.txt` for this purpose.

Please be aware that the soft dependencies are those required to typeset the demo file.
Please be aware that the soft dependencies are those required to typeset the demo file.
In case you want to use a minimal setup for this the file `.tl_packages` contains all soft dependencies with a comment informing about the reason.

## Local user level installation using l3build

This package is not yet released to CTAN, but it provides an \pkg{l3build} installation script and demo files.
Additionally to the CTAN release this package includes an `l3build` installation script inside the package repository.
Details on usage can be found in the [l3build documentation](http://texdoc.net/serve/l3build)/0).

To get started one can run
```

```shell
l3build doc
```

within the repositories root directory.
This will build the Demo project as well as the current status of the documentation within the subdirectory `build/doc`.

To Install the package within you `$TEXMFHOME` there is also the `install` action
```

```shell
l3build install
```

Expand Down
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ zugferd version 0.9a (2024-11-07)
***************************************************************************

This material is subject to the LaTeX Project Public License version 1.3c
or later. See http://www.latex-project.org/lppl.txt for details.
or later. See <http://www.latex-project.org/lppl.txt> for details.

***************************************************************************

Expand All @@ -23,12 +23,12 @@ This package does not provide any validation. Please be aware of you have to use

## Version History

* 0.9a (2024-11-07)
- Add support for MINIMUM profile
- Bugfix in demo package concerning rounding of non integer units.
* 0.9 (2024-10-23)
- Improve validation in testing of the development status.
- Add support for BillingSpecifiedPeriod
- Add additional user interfaces to simplify development for templates
* 0.8a (2024-09-17) Patch to switch to the newly public interface of l3pdfmeta
* 0.8 (2024-09-11) First version on CTAN
* 0.9a (2024-11-07)
- Add support for MINIMUM profile
- Bugfix in demo package concerning rounding of non integer units.
* 0.9 (2024-10-23)
- Improve validation in testing of the development status.
- Add support for BillingSpecifiedPeriod
- Add additional user interfaces to simplify development for templates
* 0.8a (2024-09-17) Patch to switch to the newly public interface of l3pdfmeta
* 0.8 (2024-09-11) First version on CTAN

0 comments on commit fb846c2

Please sign in to comment.