Merge branch 'main' into newdocs

Author: behinger

.pre-commit-config.yaml

@@ -26,7 +26,7 @@ repos:
       - id: check-merge-conflict
         args: [--assume-in-merge]
   - repo: https://github.com/igorshubovych/markdownlint-cli
-    rev: v0.42.0
+    rev: v0.43.0
     hooks:
       - id: markdownlint-fix
   - repo: https://github.com/citation-file-format/cffconvert
@@ -44,6 +44,6 @@ repos:
     hooks:
       - id: yamllint
   - repo: https://github.com/domluna/JuliaFormatter.jl
-    rev: v1.0.61
+    rev: v2.0.0
     hooks:
       - id: julia-formatter

Project.toml

@@ -11,6 +11,11 @@ PDFIO = "4d0d745f-9d9a-592e-8d18-1ad8a0f42b92"
 RollingFunctions = "b0e4dd01-7b14-53d8-9b45-175a3e362653"
 
 [compat]
+Makie = "0.21"
+MakieCore = "0.8"
+BSplineKit = "0.17"
+PDFIO = "0.1"
+RollingFunctions = "0.8"
 julia = "1"
 
 [extras]

README.md

@@ -1,4 +1,4 @@
-# ThesisArt
+# ThesisArt - A visual representation of intellectual pursuits
 
 [![Stable Documentation](https://img.shields.io/badge/docs-stable-blue.svg)](https://s-ccs.github.io/ThesisArt.jl/stable)
 [![In development documentation](https://img.shields.io/badge/docs-dev-blue.svg)](https://s-ccs.github.io/ThesisArt.jl/dev)
@@ -12,6 +12,18 @@
 [![All Contributors](https://img.shields.io/github/all-contributors/s-ccs/ThesisArt.jl?labelColor=5e1ec7&color=c0ffee&style=flat-square)](#contributors)
 [![BestieTemplate](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/JuliaBesties/BestieTemplate.jl/main/docs/src/assets/badge.json)](https://github.com/JuliaBesties/BestieTemplate.jl)
 
+## About
+
+<img src="https://github.com/user-attachments/assets/719c1a7c-f1a8-4b2e-8a2c-f5412e69fa29" width="30%"/>
+
+This package facilitates generation of ThesisArt pieces, which can be used as a thank-you for my BSc/MSc students. Based on their work I create a piece of art, typically with the text of the thesis. To facilitate this, plotting functions are exportet, especially the `TextOnPath` which allows, well, text on path plotting.
+
+A list of all ThesisArt can be found here: https://www.s-ccs.de/thesis-art
+
+## Thanks to
+Julius Krumbiegel for help with the TextOnPath implementation
+
+
 ## How to Cite
 
 If you use ThesisArt.jl in your work, please cite using the reference given in [CITATION.cff](https://github.com/s-ccs/ThesisArt.jl/blob/main/CITATION.cff).