Compare commits

..

2 Commits

Author SHA1 Message Date
Sven Vogel 531424f6ad added devbox json 2023-11-21 21:22:02 +01:00
Sven Vogel 67a2464c77 updated gitingore to reflect latexmkrc 2023-11-21 21:15:26 +01:00
3 changed files with 25 additions and 4 deletions

4
.gitignore vendored
View File

@ -318,5 +318,5 @@ main.pdf
# ignore build directories # ignore build directories
# these hold all the clutter we do not want to have # these hold all the clutter we do not want to have
.tmp tmp
.build build

View File

@ -28,11 +28,22 @@ This project requires the following:
- python - python
- pygments (python package for minted) - pygments (python package for minted)
## Quick start for Linux/WSL and Devbox
In the repository you will find a `devbox.json`. If you have devbox installed you can simply setup a ready to go container by running:
```shell
devbox shell
```
then inside the container compile with:
```shell
latexmk
```
Alternatively you can launch VSCode/VSCodium inside the devbox and compile with the LaTeX workstation plugin.
## Files created during build ## Files created during build
The build process of latexmk will create two folders for storing temporary cache files for faster rebuilds. The primary folder being `.tmp` which will hold every created .aux file. Additionally the resulting pdf file will be located besides main.tex as well as an index file called `main.synctex.gz` used for indexing between main.tex and main.pdf (unused by VSCode, used by Overleaf). The build process of latexmk will create two folders for storing temporary cache files for faster rebuilds. The primary folder being `.tmp` which will hold every created .aux file. Additionally the resulting pdf file will be located besides main.tex as well as an index file called `main.synctex.gz` used for indexing between main.tex and main.pdf (unused by VSCode, used by Overleaf).
Build files: Build files:
- main.pdf - main.pdf
- main.synctex.gz - main.synctex.gz
- .build/* - build/*
- .tmp/* - tmp/*

10
devbox.json Normal file
View File

@ -0,0 +1,10 @@
{
"packages": [
"texlive.combined.scheme-small",
"python311",
"python311Packages.pygments"
],
"nixpkgs": {
"commit": "f80ac848e3d6f0c12c52758c0f25c10c97ca3b62"
}
}