Skip to content

Commit

Permalink
Replace old link to kaestner/latex with working one - Closes: #9
Browse files Browse the repository at this point in the history
  • Loading branch information
PhilippMatthes committed Feb 23, 2024
1 parent 6f98d56 commit f85a50d
Show file tree
Hide file tree
Showing 4 changed files with 5 additions and 9 deletions.
2 changes: 1 addition & 1 deletion .vscode/settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,6 @@
"ltex.additionalRules.enablePickyRules": true,
"ltex.checkFrequency": "edit",
"latex-workshop.docker.enabled": true,
"latex-workshop.docker.image.latex": "kaestner/latex",
"latex-workshop.docker.image.latex": "ghcr.io/felix-kaestner/latex:1.0",
"latex-workshop.latex.autoBuild.run": "never"
}
2 changes: 1 addition & 1 deletion Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ ARG USER_ID=1000
ARG USER_NAME=latex
ARG USER_HOME=/home/latex
ARG USER_GECOS=LaTeX
ARG BASE_IMAGE=kaestner/latex
ARG BASE_IMAGE=ghcr.io/felix-kaestner/latex:1.0

FROM ${BASE_IMAGE} as latex

Expand Down
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ DIR:=$(shell sh -c "pwd")
USER_ID:=$(shell sh -c "id -u")
USER_NAME:=$(shell sh -c "id -u -n")
USER_HOME:=/home/latex
BASE_IMAGE:=kaestner/latex
BASE_IMAGE:=ghcr.io/felix-kaestner/latex:1.0
DOCKER_IMAGE:=mustermann/latex

# Check if any of the args are empty.
Expand Down
8 changes: 2 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,6 @@
# better-tudscr
A template for the tudscr (TUD-Script) LaTeX package. Contains an initial template for any thesis and a containerized build environment with Docker, so that you don’t have to fiddle around with the installation of LaTeX. Just build the Docker image _once_ in advance and use it to build your thesis.

## ⚠️ Help wanted - Docker build currently not functional

Please see the Issues section of this repository, to help improve this template. Currently, the Docker image `kaestner/latex` seems to be no longer available, meaning that we have to upgrade to another image. In the meantime, this repository can still be used as a basic template for your LaTeX-based TU Dresden thesis.

## Quickstart

1. Build the Docker image _once_ with `make container`.
Expand Down Expand Up @@ -51,7 +47,7 @@ The following workspace settings are defined in `.vscode/settings.json`:
- `"ltex.additionalRules.enablePickyRules": true` - enables warnings for picky rules such as passive voice or sentence length.
- `"ltex.checkFrequency": "edit"` - will check spelling and grammar while you are typing. If you want you can set this value to `save`, if you only want to check after you saved the file.
- `"latex-workshop.docker.enabled": true` - enables to docker mode of the `latex-workshop` extension. Thus, no local installation of LaTeX is needed, since it will use docker to build the thesis.
- `"latex-workshop.docker.image.latex": "kaestner/latex"` - defines the docker image, which is used to build the thesis using the `latex-workshop` extension. This will be [kaestner/latex](https://hub.docker.com/repository/docker/kaestner/latex)
- `"latex-workshop.docker.image.latex": "ghcr.io/felix-kaestner/latex:1.0"` - defines the docker image, which is used to build the thesis using the `latex-workshop` extension. This will be [felix-kaestner/latex](https://github.com/felix-kaestner/latex)
- `"latex-workshop.latex.autoBuild.run": "never"` - disables automatic runs of the `latex-workshop` extension. You can manually trigger a build by using the command prompt in VS Code or by clicking on the Play-Button in the top right.

### Explanation
Expand All @@ -60,4 +56,4 @@ Instead of keeping a local copy of LaTeX, this repository simplifies the process

In order to avoid user permission problems, you build a custom docker image _once_ in advance, which will create a user which has the same name and user ID as your local user on your machine. As a result there will be no problems, since the files will have the correct permissions set.

This repository uses [kaestner/latex](https://hub.docker.com/repository/docker/kaestner/latex) as the base docker image which is created by [Felix Kästner](https://felix-kaestner.com) over [here](https://github.com/felix-kaestner/latex). This image is only 1.3GB in size, which results in faster build times using the CI.
This repository uses [felix-kaestner/latex](https://github.com/felix-kaestner/latex) as the base docker image which is created by [Felix Kästner](https://felix-kaestner.com) over [here](https://github.com/felix-kaestner/latex). This image is only 1.3GB in size, which results in faster build times using the CI.

0 comments on commit f85a50d

Please sign in to comment.