From 071119645058c635a7cd4a9473660844052b3a7c Mon Sep 17 00:00:00 2001 From: Kai Norman Clasen <46302524+kai-tub@users.noreply.github.com> Date: Sat, 30 May 2020 11:25:00 +0200 Subject: [PATCH] Renamed demo + Added `v` to SimVer in files (Potentially unstable release) (#39) * Small change to version numbering To keep it consistent with GitHub tags, this version uses vX.X.X instead of X.X.X --- .github/workflows/build_and_release.yml | 4 ++-- .github/workflows/convert_pdf_to_png.fish | 4 ++-- .github/workflows/upload_assets.yml | 24 +++++++++---------- .gitignore | 2 +- CONTRIBUTING.md | 2 +- README.md | 18 +++++++------- auto_scripts/update_package_versioning.sh | 3 ++- ... => beamertheme-pure-minimalistic-demo.tex | 0 8 files changed, 29 insertions(+), 28 deletions(-) rename demo.tex => beamertheme-pure-minimalistic-demo.tex (100%) diff --git a/.github/workflows/build_and_release.yml b/.github/workflows/build_and_release.yml index e66542c..6e852d3 100644 --- a/.github/workflows/build_and_release.yml +++ b/.github/workflows/build_and_release.yml @@ -46,7 +46,7 @@ jobs: latexmk -pdf -file-line-error -interaction=nonstopmode *example*.tex - name: Build demo document run: | - latexmk -pdf -file-line-error -interaction=nonstopmode demo.tex + latexmk -pdf -file-line-error -interaction=nonstopmode beamertheme-pure-minimalistic-demo.tex - name: PDFs to PNGs uses: docker://frapsoft/fish:latest with: @@ -56,7 +56,7 @@ jobs: uses: kai-tub/external-repo-sync-action@v1 with: source-directory: "./" - include-patterns: "demo.pdf *.png" + include-patterns: "beamertheme-pure-minimalistic-demo.pdf *.png" exclude-patterns: "*.tmp.png logos" commit-message: "Updating LaTeX documentation files" env: diff --git a/.github/workflows/convert_pdf_to_png.fish b/.github/workflows/convert_pdf_to_png.fish index 90455ee..b44447e 100644 --- a/.github/workflows/convert_pdf_to_png.fish +++ b/.github/workflows/convert_pdf_to_png.fish @@ -26,8 +26,8 @@ function convert_compare_examples end function convert_demo - convert -density 300 demo.pdf demo-%02d.tmp.png - montage demo-*.png -geometry +10+10 -tile 4x -background gray demo.png + convert -density 300 beamertheme-pure-minimalistic-demo.pdf beamertheme-pure-minimalistic-demo-%02d.tmp.png + montage beamertheme-pure-minimalistic-demo-*.png -geometry +10+10 -tile 4x -background gray beamertheme-pure-minimalistic-demo.png end apk add --no-cache imagemagick diff --git a/.github/workflows/upload_assets.yml b/.github/workflows/upload_assets.yml index 22a0a96..6626a5f 100644 --- a/.github/workflows/upload_assets.yml +++ b/.github/workflows/upload_assets.yml @@ -14,36 +14,36 @@ jobs: steps: - name: Set up Git uses: actions/checkout@v2 - - name: Get demo.pdf - run: wget https://github.com/kai-tub/latex-beamer-pure-minimalistic/wiki/demo.pdf -O demo.pdf + - name: Get beamertheme-pure-minimalistic-demo.pdf + run: wget https://github.com/kai-tub/latex-beamer-pure-minimalistic/wiki/beamertheme-pure-minimalistic-demo.pdf -O beamertheme-pure-minimalistic-demo.pdf - name: Get release id: release uses: bruceadams/get-release@v1.2.0 - name: Create archives run: | - mkdir -p pure-minimalistic-beamertheme - cp -r {*.sty,demo.tex,demo.pdf,README.md,LICENSE,demo_bib.bib,logos} pure-minimalistic-beamertheme - zip -r pure-minimalistic-beamertheme.zip pure-minimalistic-beamertheme - tar cfvz pure-minimalistic-beamertheme.tar.gz pure-minimalistic-beamertheme + mkdir -p beamertheme-pure-minimalistic + cp -r {*.sty,beamertheme-pure-minimalistic-demo.tex,beamertheme-pure-minimalistic-demo.pdf,README.md,LICENSE,demo_bib.bib,logos} beamertheme-pure-minimalistic + zip -r beamertheme-pure-minimalistic.zip beamertheme-pure-minimalistic + tar cfvz beamertheme-pure-minimalistic.tar.gz beamertheme-pure-minimalistic - name: Upload zip asset uses: actions/upload-release-asset@v1 with: upload_url: ${{ steps.release.outputs.upload_url }} - asset_path: ./pure-minimalistic-beamertheme.zip - asset_name: pure-minimalistic-beamertheme.zip + asset_path: ./beamertheme-pure-minimalistic.zip + asset_name: beamertheme-pure-minimalistic.zip asset_content_type: application/zip - name: Upload tar.gz asset uses: actions/upload-release-asset@v1 with: upload_url: ${{ steps.release.outputs.upload_url }} - asset_path: ./pure-minimalistic-beamertheme.tar.gz - asset_name: pure-minimalistic-beamertheme.tar.gz + asset_path: ./beamertheme-pure-minimalistic.tar.gz + asset_name: beamertheme-pure-minimalistic.tar.gz asset_content_type: application/tar.gz - - name: Upload demo.pdf + - name: Upload beamertheme-pure-minimalistic-demo.pdf uses: actions/upload-release-asset@v1 with: upload_url: ${{ steps.release.outputs.upload_url }} - asset_path: ./demo.pdf + asset_path: ./beamertheme-pure-minimalistic-demo.pdf asset_name: demo.pdf asset_content_type: application/pdf \ No newline at end of file diff --git a/.gitignore b/.gitignore index ec1ee5c..151305b 100644 --- a/.gitignore +++ b/.gitignore @@ -282,7 +282,7 @@ TSWLatexianTemp* # Uncomment the next line to have this generated file ignored. #*Notes.bib .vscode/ -/demo.pdf +/beamertheme-pure-minimalistic-demo.pdf /demo-screenshots/* /deploy.sh /dev diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 314fb1e..aac2bdd 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -15,7 +15,7 @@ If you find a typo in the documentation, do not hesitate to submit a GitHub pull ## PR guide If you implemented a new feature, you should add a new minimal example in the [minimal_examples](./minimal_examples/) folder. -Then the [demo.tex](demo.tex) file should be modified to explain +Then the [beamertheme-pure-minimalistic-demo.tex](beamertheme-pure-minimalistic-demo.tex) file should be modified to explain how the option should be used and what the effect is. In every PR, all minimal examples will be compiled automatically. diff --git a/README.md b/README.md index b16b3dd..816c008 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@ not on the slides. Requires the packages [fira](https://ctan.org/pkg/fira) and [silence](https://ctan.org/pkg/silence) to be installed on your system. -To build the [demo.tex](demo.tex) file, +To build the [beamertheme-pure-minimalistic-demo.tex](beamertheme-pure-minimalistic-demo.tex) file, [PGF/TikZ](https://ctan.org/pkg/pgf), [appendixnumberbeamer](https://ctan.org/pkg/appendixnumberbeamer), [fontaxes](https://ctan.org/pkg/fontaxes), and @@ -52,23 +52,23 @@ To build the [demo.tex](demo.tex) file, # Demo A sample document can be seen in the -[demo.pdf](https://github.com/kai-tub/latex-beamer-pure-minimalistic/wiki/demo.pdf), -produced from [demo.tex](demo.tex). +[beamertheme-pure-minimalistic-demo.pdf](https://github.com/kai-tub/latex-beamer-pure-minimalistic/wiki/demo.pdf), +produced from [beamertheme-pure-minimalistic-demo.tex](beamertheme-pure-minimalistic-beamertheme-pure-minimalistic-demo.tex). The document shows all of the design decisions, as well as some packages and commands that work well for presentations. For example, starting the frame counter after the *Table of Contents* section does not include backup slides to the total frame counter. -Please use [demo.tex](demo.tex) +Please use [beamertheme-pure-minimalistic-demo.tex](beamertheme-pure-minimalistic-demo.tex) as a starting point, as exhaustive comments were added for a smooth start. -[Here](https://github.com/kai-tub/latex-beamer-pure-minimalistic/wiki/demo.png) -a short *inline teaser* version of the [demo.pdf](https://github.com/kai-tub/latex-beamer-pure-minimalistic/wiki/demo.pdf) can be seen. +[Here](https://github.com/kai-tub/latex-beamer-pure-minimalistic/wiki/beamertheme-pure-minimalistic-demo.png) +a short *inline teaser* version of the [beamertheme-pure-minimalistic-demo.pdf](https://github.com/kai-tub/latex-beamer-pure-minimalistic/wiki/beamertheme-pure-minimalistic-demo.pdf) can be seen. -![demo.png](https://github.com/kai-tub/latex-beamer-pure-minimalistic/wiki/demo.png) +![beamertheme-pure-minimalistic-demo.png](https://github.com/kai-tub/latex-beamer-pure-minimalistic/wiki/beamertheme-pure-minimalistic-demo.png) -Please look at the [PDF](https://github.com/kai-tub/latex-beamer-pure-minimalistic/wiki/demo.pdf) version for high-resolution images. :) +Please look at the [PDF](https://github.com/kai-tub/latex-beamer-pure-minimalistic/wiki/beamertheme-pure-minimalistic-demo.pdf) version for high-resolution images. :) I highly recommend [pympress](https://github.com/Cimbali/pympress) to add videos to the presentation. This presentation tool works perfectly with @@ -107,7 +107,7 @@ LaTeX source file. Then include the theme by writing: # Customize All options and commands are also described in detail in the -[demo.pdf](https://github.com/kai-tub/latex-beamer-pure-minimalistic/wiki/demo.pdf). +[beamertheme-pure-minimalistic-demo.pdf](https://github.com/kai-tub/latex-beamer-pure-minimalistic/wiki/beamertheme-pure-minimalistic-demo.pdf). ## Customize Logos By default, the theme expects the logos to be present in a diff --git a/auto_scripts/update_package_versioning.sh b/auto_scripts/update_package_versioning.sh index e590b08..24794d3 100644 --- a/auto_scripts/update_package_versioning.sh +++ b/auto_scripts/update_package_versioning.sh @@ -26,7 +26,8 @@ fi # bump version newVersion=$( bash "${scriptFolder}/semvertool.sh" bump "$bumpType" "$currentVersion" ) +newVersionWithV="v$newVersion" -sed -r -i "s/(\\ProvidesPackage\{\w+\})\[.*\]/\1\[${newVersion}\]/g" -- *.sty +sed -r -i "s/(\\ProvidesPackage\{\w+\})\[.*\]/\1\[${newVersionWithV}\]/g" -- *.sty # Files will be commited via `auto` tool git add . diff --git a/demo.tex b/beamertheme-pure-minimalistic-demo.tex similarity index 100% rename from demo.tex rename to beamertheme-pure-minimalistic-demo.tex