update template

.devcontainer/devcontainer.json

@@ -0,0 +1,12 @@
+{
+    "name": "LaTeX4Ei Devcontainer",
+    "image": "makeappdev/uselatex:latest",
+    "extensions": [
+        "eamodio.gitlens",
+        "James-Yu.latex-workshop",
+        "ms-azuretools.vscode-docker",
+        "ms-vscode-remote.vscode-remote-extensionpack",
+        "ms-vscode.cmake-tools",
+        "twxs.cmake"
+    ],
+}

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,5 @@
+blank_issues_enabled: true
+contact_links:
+  - name: 🔍 Search for existing issues first.
+    url: https://github.com/latex4ei/Allgemein/issues
+    about: Please search to see if an issue already exists, either in this repo or our common issue in https://github.com/latex4ei/Allgemein/issues

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: enhancement
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/ISSUE_TEMPLATE/feature_request.yaml

@@ -0,0 +1,45 @@
+name: Feature request
+description: Suggest an idea for this project
+labels: [enhancement]
+assignees: []
+
+body:
+- type: markdown
+    attributes:
+        value: |
+            **Is your feature request related to a problem? Please describe.**
+- type: textarea
+    id: problem-description
+    attributes:
+        label: Problem Description
+        description: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+- type: markdown
+    attributes:
+        value: |
+            **Describe the solution you'd like**
+- type: textarea
+    id: solution-description
+    attributes:
+        label: Solution Description
+        description: A clear and concise description of what you want to happen.
+
+- type: markdown
+    attributes:
+        value: |
+            **Describe alternatives you've considered**
+- type: textarea
+    id: alternatives-description
+    attributes:
+        label: Alternatives Description
+        description: A clear and concise description of any alternative solutions or features you've considered.
+
+- type: markdown
+    attributes:
+        value: |
+            **Additional context**
+- type: textarea
+    id: additional-context
+    attributes:
+        label: Additional Context
+        description: Add any other context or screenshots about the feature request here.

.github/ISSUE_TEMPLATE/inhaltlicher_fehler.md

@@ -0,0 +1,14 @@
+---
+name: Inhaltlicher Fehler
+about: Hilf uns Fehler zu Verbessern
+title: ''
+labels: bug
+assignees: ''
+
+---
+
+**Fehlerbeschreibung**
+Beschreibe hier den Fehler
+
+**Referenz**
+Wenn möglich immer eine Referenz zum Skript o.ä. angeben oder als Screenshot mit einfügen.

.github/ISSUE_TEMPLATE/inhaltlicher_fehler.yaml

@@ -0,0 +1,25 @@
+name: Inhaltlicher Fehler
+description: Hilf uns Fehler zu Verbessern
+labels: [bug]
+assignees: []
+
+body:
+- type: markdown
+  attributes:
+    value: |
+      **Fehlerbeschreibung**
+- type: textarea
+  id: error-description
+  attributes:
+    label: Fehlerbeschreibung
+    description: Beschreibe hier den Fehler
+
+- type: markdown
+  attributes:
+    value: |
+      **Referenz**
+- type: textarea
+  id: reference
+  attributes:
+    label: Referenz
+    description: Wenn möglich immer eine Referenz zum Skript o.ä. angeben oder als Screenshot mit einfügen.

.github/pull_request_template.md

@@ -0,0 +1,14 @@
+---
+name: Vorschlag Fehlerkorrektur
+about: Du hast einen Fehler gefunden und willst ihn korrigieren
+title: ''
+labels: bug
+assignees: ''
+
+---
+
+**Fehlerbeschreibung**
+Beschreibe hier den Fehler
+
+**Referenz**
+Wenn möglich immer eine Referenz zum Skript o.ä. angeben oder als Screenshot mit einfügen.

.github/workflows/ci.yml

@@ -0,0 +1,60 @@
+name: CI
+
+on:
+  push:
+    branches: [ master, main ]
+  pull_request:
+    branches: [ master, main ]
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: '3.12.2'
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -r scripts/requirements.txt
+    - name: Run pytest
+      run: pytest
+
+  build:
+    runs-on: ubuntu-latest
+    container: makeappdev/uselatex:latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Configure Git safe directory with GITHUB_WORKSPACE
+        run: git config --global --add safe.directory $GITHUB_WORKSPACE
+
+      - name: Build
+        run: |
+          cmake --version; pdflatex --version
+          mkdir -p build && cd build
+          cmake ..
+          make
+
+      - name: Prepare Deployment
+        if: github.ref == 'refs/heads/master' || github.ref == 'refs/heads/main'
+        run: |
+          mkdir -p export
+          echo "# This branch is for deployment only" >> export/README.md
+          cp build/*.pdf export
+          cp build/git.id export
+
+      - name: Deploy
+        if: github.ref == 'refs/heads/master' || github.ref == 'refs/heads/main'
+        uses: JamesIves/github-pages-deploy-action@v4.5.0
+        with:
+          branch: gh-pages
+          folder: export
+          single-commit: true
+          silent: true

.github/workflows/update.yml

@@ -0,0 +1,43 @@
+name: Update README and LaTeX Build File
+
+on:
+  workflow_dispatch:
+
+jobs:
+  update-and-create-pr:
+    runs-on: ubuntu-latest
+
+    env:
+      GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      DEFAULT_BRANCH: ""
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.12.2'
+
+      - name: Run update script
+        run: python scripts/update_files.py
+
+      - name: Configure Git
+        run: |
+          git config user.name "github-actions[bot]"
+          git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
+
+      - name: Get default branch
+        run: echo "DEFAULT_BRANCH=$(gh api repos/${{ github.repository }} --jq .default_branch)" >> $GITHUB_ENV
+
+      - name: Commit changes to a new branch
+        run: |
+          git checkout -b changes/${{ github.run_id }}
+          git add .
+          git commit -m "Apply automated updates"
+          git push -u origin changes/${{ github.run_id }}
+      
+      - name: Create Pull Request
+        run: |
+          gh pr create --base $DEFAULT_BRANCH --head changes/${{ github.run_id }} --title "Specify project URLs and CMake project" --body "Please review the changes applied by the automated script."

.gitignore

@@ -1,6 +1,6 @@
 build/
 
-Analysis-3.pdf
+/*.pdf
 
 ## Core latex/pdflatex auxiliary files:
 *.aux
@@ -111,4 +111,6 @@ sympy-plots-for-*.tex/
 
 # xindy
 *.xdy
-StochastischeSignale.pdf
+git.id
+*.DS_Store
+*.pyc

CMakeLists.txt

@@ -1,6 +1,6 @@
-cmake_minimum_required(VERSION 2.8)
+cmake_minimum_required(VERSION 3.12)
 
-project(Analysis3 NONE)
+project(CheatsheetTemplate NONE)
 include(UseLATEX)
 
 add_custom_target(
@@ -9,10 +9,16 @@ add_custom_target(
     WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
 )
 
+set(IMAGE_DIRS
+    img
+    # Add subdirectories here
+    # img/logic
+    # img/rca
+)
+
 add_latex_document(
-    Analysis-3.tex
+    CheatsheetTemplate.tex
     FORCE_PDF
-    IMAGE_DIRS img
-    INCLUDE_DIRECTORIES ${CMAKE_CURRENT_SOURCE_DIR}
+    IMAGE_DIRS ${IMAGE_DIRS}
     DEPENDS writegitid
 )

LICENSE

@@ -26,4 +26,4 @@ If you want to publish your latex code you are allowed to publish the source cod
 of this template as well but you have to make sure that a copy of this license is included.
 
 
-© 2011-2020, LaTeX4EI
+© 2011-2024, LaTeX4EI

README.md

@@ -1,8 +1,10 @@
-# Analysis 3
+# LaTeX4EI Cheatsheet Template
 
-[![Build Status](https://travis-ci.org/latex4ei/Analysis-3.svg?branch=master)](https://travis-ci.org/latex4ei/Analysis-3)
+[![Actions Status](https://github.com/latex4ei/CheatsheetTemplate/workflows/CI/badge.svg)](https://github.com/latex4ei/CheatsheetTemplate)
 [![Join the chat at https://gitter.im/LaTeX4Ei/Lobby](https://badges.gitter.im/LaTeX4Ei/Lobby.svg)](https://gitter.im/LaTeX4Ei/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
+Write beautiful latex cheat sheets with minimal effort.
+
 ## Formelsammlung für Latex4ei
 
 **Required custom Package on GitHub:** [LaTeX4Ei](https://github.com/latex4ei/latex4ei-packages)
@@ -21,3 +23,7 @@ cd build
 cmake ..
 make
 ```
+## Disclaimer
+
+After changing the repository name or transfering ownership, run the "Update README and LaTeX Build" workflow from the Actions tab and merge the generated pull request.
+Make sure the `.tex` file has the same name as the repository in order for it to build correctly!

scripts/requirements.txt

@@ -0,0 +1,2 @@
+pyfakefs==5.3.5
+pytest==8.1.1