Merge pull request #262 from sepehr541/patch-4

Update README.md for pygments lexer for Overleaf

Author: fhackett

syntax/pygments/README.md

@@ -28,4 +28,24 @@ pygmentize -f html -O full -o output.html /path/to/input.tla
 ```
 
 For syntax highlighting inside Latex docuemtns, we use [minted](https://ctan.org/pkg/minted?lang=en) package. For more
-information see the provided [example](latex/main.tex).
+information see the provided [example](latex/main.tex).
+
+### Overleaf
+To use the MPCal and TLA+ lexers provided here on [Overleaf](overleaf.com):
+1. Upload the `mpcallexer/lexer.py` file to your Overleaf project's top-most level (i.e., root directory).
+2. Change your TeX Live version to 2022 or earlier, see (link)[https://www.overleaf.com/learn/latex/Code_Highlighting_with_minted#Custom_lexers].
+3. Use `\begin{minted}{lexer.py:TLAplusLexer -x}` to redirect highlighting to the custom lexer.
+   - For TLA+: `{lexer.py:TLAPlusLexer -x}`
+   - For MPCal: `{lexer.py:MPCalLexer -x}`
+  
+4. A minted environment can be defined to avoid repetition:
+   - definition:
+     ```latex
+     \newminted[tlaplus]{lexer.py:TLAplusLexer -x}{fontsize=\small, linenos}
+     ```
+   - usage:
+     ```latex
+     \begin{tlaplus}
+     ...
+     \end{tlaplus}
+     ```