Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Use a build system for easy regeneration of the thesis #18

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

whisperity
Copy link
Contributor

latexmk together with make can trivialise and simplify rebuilding the ongoing thesis work to just simply calling make.

`latexmk` together with `make` can trivialise and simplify rebuilding
the ongoing thesis work to just simply calling `make`.
```bash
# Generate everything automatically, in the right order.
# (Needs GNU make to be installed!)
make thesis
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This will build both the English and the Hungarian version if I see it correctly; however that rarely makes sense, as these are only sample files and only one of them is usually used.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Understood, but in this case, which one should be the main document. 😕 Because right now, they appear as "siblings" in the repository. Perhaps I could make it so that the 🇬🇧 tutorial shows calling make thesis-en and the 🇭🇺 tutorial tells the user to call make thesis-hu?

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In general we can expect that a user renames the used template (e.g. from elteikthesis_en.tex to mythesis.tex) and deletes the unused one; so I suggest there should be some option for custom parametrization.

```bash
# Mindent lefordít automatikusan, a megfelelő sorrendben.
# (GNU make kell hozzá!)
make
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

While the default target also leads to thesis, the English and Hungarian readme should be consistent, so use make thesis here as well.


# Ugyanaz, mint az előző, csak közvetlenül a LaTeX-mk-t hívva:
# (Elérhető standard TeX disztribúcióval, make nélkül.)
latexmk --pdflatex elteikthesis_hu
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It should be noted that latexmk requires Perl to be installed.

latexmk --pdflatex elteikthesis_hu
```

### Kézzel
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Bit strange for me, maybe "Manuálisan" would be better.

@@ -14,6 +14,22 @@ The template supports producing both Hungarian and English theses, which can be

## Compilation

Compilation might be carried out through a preferred IDE (e.g. [TexStudio](https://www.texstudio.org/)), given the same commands should be executed.
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is good that is remark was moved here, but "given the same commands should be executed" is now ambiguous to what is refers. Maybe it could be stated that the commands in the Manually section. (I don't know whether TexStudio supports latexmk.)

@@ -9,6 +9,22 @@ A sablon magyar és angol nyelvű dokumentumok elkészítését is támogatja (l

## Fordítás

A fordításhoz tetszőleges fejlesztő környezet is használható (pl. [TexStudio](https://www.texstudio.org/)), ugyanezen utasítások kiadásával.
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Similar comment like for the English version.

@mcserep mcserep added the enhancement New feature or request label Apr 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants