summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/wordle/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/latex/wordle/README.md')
-rw-r--r--Master/texmf-dist/doc/latex/wordle/README.md41
1 files changed, 33 insertions, 8 deletions
diff --git a/Master/texmf-dist/doc/latex/wordle/README.md b/Master/texmf-dist/doc/latex/wordle/README.md
index f1977a1ae76..fdfd9968701 100644
--- a/Master/texmf-dist/doc/latex/wordle/README.md
+++ b/Master/texmf-dist/doc/latex/wordle/README.md
@@ -1,8 +1,33 @@
-wordle is a package to work with Wordle game.
------------------------------------------------------------
-wordle est un package pour travailler avec le jeu du sutom.
------------------------------------------------------------
-Author : Cédric Pierquet
-email : cpierquet@outlook.fr
-Licence : Released under the LaTeX Project Public License v1.3c or later, see http://www.latex-project.org/lppl.txt
-Source : https://tex.stackexchange.com/questions/659860/wordle-like-colored-letter-boxes-in-latex \ No newline at end of file
+![v![]()ersion](https://img.shields.io/github/v/tag/AndrewMathas/wordle?color=success&label=version)
+<a href="http://www.latex-project.org/lppl.txt"><img src="https://img.shields.io/badge/license-LPPLv1.3c-blueviolet.svg"></a>
+<a href="https://www.latex-project.org/"><img src="https://img.shields.io/badge/latex-20B2AA?logo=Latex"></a>
+
+# Wordle
+
+A stupidly feature-rich LaTeX package for typesetting **Wordle** puzzles. This package provides a stupidly feature-rich way of creating Wordle puzzles in LaTeX, which [Wikipedia](https://en.wikipedia.org/wiki/Wordle) describes as a hugely popular web-based word game created and developed by Welsh software engineer Josh Wardle.
+
+This package provides the `wordle` environment, which uses the syntax:
+
+```tex
+% \usepackage{wordle}
+\begin{wordle}{ANVIL}
+ CRANE
+ NATAL
+ ANVIL
+\end{wordle}
+```
+
+Ce package fournit un moyen stupidement riche en fonctionnalités de créer des puzzles **Wordle** en LaTeX, que [Wikipedia](https://en.wikipedia.org/wiki/Wordle) décrit comme comme un jeu de lettres en ligne extrêmement populaire, créé et développé par l'ingénieur logiciel gallois Josh Wardle.
+
+```tex
+% \usepackage{wordle}
+\begin{GrilleSutom}{REBUS}
+ ABRIS
+ ROUTE
+ REBUS
+\end{GrilleSutom}
+```
+
+### Authors
+Andrew Mathas and Cédric Pierquet
+