Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
kjarosh committed Aug 23, 2024
1 parent e7b9ea4 commit e1c1ca9
Showing 1 changed file with 48 additions and 4 deletions.
52 changes: 48 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# LaTeX in Docker

[![GitHub license](https://img.shields.io/github/license/kjarosh/latex-docker)](https://github.com/kjarosh/latex-docker/blob/main/LICENSE)
[![GitHub build status](https://img.shields.io/github/actions/workflow/status/kjarosh/latex-docker/docker.yml?branch=main)](https://github.com/kjarosh/latex-docker/actions)
[![GitHub build status](https://img.shields.io/github/actions/workflow/status/kjarosh/latex-docker/docker.yaml?branch=main)](https://github.com/kjarosh/latex-docker/actions)
[![GitHub release](https://img.shields.io/github/v/release/kjarosh/latex-docker)](https://github.com/kjarosh/latex-docker/releases)
[![DockerHub](https://img.shields.io/badge/docker.io-kjarosh%2Flatex-blue)](https://hub.docker.com/r/kjarosh/latex)
[![GitHub Container Registry](https://img.shields.io/badge/ghcr.io-kjarosh%2Flatex-blue)](https://github.com/users/kjarosh/packages/container/package/latex)
Expand Down Expand Up @@ -35,11 +35,55 @@ For example `full` will add a layer to `medium` with packages that are
not present there.
This makes it easier to manage and saves space.

Versions are in the format of `<major>.<minor>`.
## Versions

There are several types of versions described below.

*If you're unsure which version to use, use the latest stable version.*

### Stable Versions

Stable versions are in the format of `<major>.<minor>` (e.g. `2022.1`).
The major version relates to TeX Live version (which is the year),
the minor version is the version of the image within the given year.
In order for `tlmgr` to work, the year in the version must be current,
because the default mirror does not support archival TeX Live releases.

Stable versions offer image updates & fixes and include the
set of packages for the given TeX Live version at the time of release.

| TeX Live version | Latest stable version |
| ---------------- | --------------------- |
| 2024 | `2024.2` |
| 2023 | `2023.1` |
| 2022 | `2022.1` |
| 2021 | `2021.2` |

All stable versions are available on the [releases page](https://github.com/kjarosh/latex-docker/releases).

### Development Versions

If you want to use the newest TeX Live or visit an old release
from the past, you can use development versions.

Development versions are released automatically
every day and come in several formats:

1. `devel` &mdash; The lastest development build which uses the main TL mirror.
Using this version is **highly discouraged**, especially in CI/CD,
as in case a newer TeX Live release appears, `tlmgr` will not work.

2. `devel-<TL_VERSION>-<DATE>` &mdash; A development version containing TeX Live
in version `<TL_VERSION>`, based on a historic mirror from `<DATE>` (so that `tlmgr` will work).
Usually these images are created once and not updated in the future.

3. `devel-<TL_VERSION>` &mdash; The newest development build for the given TeX Live release.
When `<TL_VERSION>` is the current TeX Live version, this image will
usually be newer than the latest stable release of `<TL_VERSION>`.
However, when `<TL_VERSION>` is not the current TeX Live version, the latest
stable release usually will contain maintenance fixes and base image updates.

4. `devel-any-<DATE>` &mdash; A development version containing TeX Live from `<DATE>`.
This is the same as `devel-<TL_VERSION>-<DATE>`, but without `<TL_VERSION>` in case
someone wants to use the TeX Live from `<DATE>` without knowing `<TL_VERSION>`.

## GitHub Actions

Expand Down

0 comments on commit e1c1ca9

Please sign in to comment.