From 531424f6adec4377f9170fc06d61256a4e9ddd1e Mon Sep 17 00:00:00 2001
From: servostar <sven.vogel123@web.de>
Date: Tue, 21 Nov 2023 21:22:02 +0100
Subject: [PATCH] added devbox json

---
 README.md   | 15 +++++++++++++--
 devbox.json | 10 ++++++++++
 2 files changed, 23 insertions(+), 2 deletions(-)
 create mode 100644 devbox.json

diff --git a/README.md b/README.md
index 4bc8640..e8c1d0f 100644
--- a/README.md
+++ b/README.md
@@ -28,11 +28,22 @@ This project requires the following:
 - python
 - 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
 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:
 - main.pdf
 - main.synctex.gz
-- .build/*
-- .tmp/*
\ No newline at end of file
+- build/*
+- tmp/*
diff --git a/devbox.json b/devbox.json
new file mode 100644
index 0000000..b43574d
--- /dev/null
+++ b/devbox.json
@@ -0,0 +1,10 @@
+{
+    "packages": [
+        "texlive.combined.scheme-small",
+        "python311",
+        "python311Packages.pygments"
+    ],
+    "nixpkgs": {
+        "commit": "f80ac848e3d6f0c12c52758c0f25c10c97ca3b62"
+  }
+}