docs: add short comments for usage

deploy/gunicorn-deploy.py

@@ -9,6 +9,12 @@
 #  the Free Software Foundation, either version 3 of the License, or
 #  (at your option) any later version.
 
+#  Method: Deployment compilation
+#  Usage:
+#  1. Meet system requirements: macOS or Linux Operating Systems, TeX Distribution (TeX Live/MiKTeX/MacTeX) and Python 3.6+ with flask and gunicorn packages.
+#  2. Run this script by `python gunicorn-deploy.py`.
+#  See the documentation https://github.com/LogCreative/PGFPlotsEdt/blob/master/docs/README.md#deployment-compilation for details.
+
 import multiprocessing
 from pathlib import Path
 import os

docs/build.lua

@@ -1,6 +1,6 @@
 #!/usr/bin/env texlua
 -- typeset the documentation for a certain language:
--- PPEDT_LANG=chs l3build doc
+-- `PPEDT_LANG=chs l3build doc`
 -- You need to rename the file manually.
 -- Please typeset the English documentation in the last run.
 

docs/pgfplotsedt.tex

@@ -1,4 +1,6 @@
 % ! TeX program = lualatex
+% Use `l3build doc` to compile the documentation.
+% Set the environment variable PPEDT_LANG to choose the language to compile.
 
 \documentclass{l3doc}
 

ppedt_server.py

@@ -9,6 +9,13 @@
 #  the Free Software Foundation, either version 3 of the License, or
 #  (at your option) any later version.
 
+#  Method: Open locally
+#  Usage:
+#  1. Meet system requirements: TeX Distribution (TeX Live/MiKTeX/MacTeX) and Python 3.6+ with flask package.
+#  2. Run this script by `python ppedt_server.py`
+#  3. Open your browser and visit `http://127.0.0.1:5678/`. Terminate the server by `Ctrl+C`.
+#  See the documentation https://github.com/LogCreative/PGFPlotsEdt/blob/master/docs/README.md#open-locally for details.
+
 import os
 import shutil
 import subprocess

ppedt_server_llm.py

@@ -9,6 +9,13 @@
 #  the Free Software Foundation, either version 3 of the License, or
 #  (at your option) any later version.
 
+#  Method: PGFPlotsEdt with LLM
+#  Usage:
+#  1. Meet system requirements: GPU with 6GB VRAM, TeX Distribution (TeX Live/MiKTeX/MacTeX) and Anaconda.
+#  2. Create the conda environment by `conda env update -n ppedt -f ppedt_server_llm.yml`.
+#  3. Activate the conda environment: `conda activate ppedt`.
+#  4. Run: `python ppedt_server_llm.py`.
+#  See the documentation https://github.com/LogCreative/PGFPlotsEdt/blob/master/docs/README.md#pgfplots-with-llm for details.
 
 import os
 import shutil