From 2b4571e166584e9b63a45bfebb1e90e9fba9d697 Mon Sep 17 00:00:00 2001
From: "Lucas Shen Y. S." <lucas@lucasshen.com>
Date: Wed, 23 Oct 2024 21:44:42 +0800
Subject: [PATCH] Update README.md

---
 README.md | 48 +++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 47 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 7f57ee1..af00a27 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,48 @@
 # texCheckmate
-Shell utilities to inspect a LaTeX manuscript
+Shell utilities to inspect a LaTeX manuscript. 
+
+Most are taken from Jonathan Dingel's [https://github.com/jdingel/projecttemplate/blob/master/paper/reviewing/Makefile](https://github.com/jdingel/projecttemplate/blob/master/paper/reviewing/Makefile).
+
+## Use with `Make`
+Comes with a `Makefile`, with quick CLI access to the utilities, some of which calling scripts from [https://github.com/LSYS/texCheckmate/tree/main/inspecting](https://github.com/LSYS/texCheckmate/tree/main/inspecting). 
+
+```text
+acronyms         Find and tally acronyms
+aynumeric        Change author-year to numeric citation
+cleantex         Clean aux output files in LaTex compilation
+dueto            Find "due to"s; Did you mean "because of", "owing to", or "from"?
+duplicated_labels Check for duplicated labels
+hardcodednumbers Find hardcoded numbers
+help             Show this help message and exit
+inspect          Do all inspections of manuscript
+linkchecker      Check URLs
+numericay        Change author-year to numeric citation
+repeated_strings Check for repeated words
+textidote        Check with textidote
+unreferenced_labels Check for label referencing
+wordcount        Wordcount via texcount
+```
+
+
+## Porting
+To download the utilities without cloning:
+
+1. Download the zipped repo
+
+```bash
+wget -v https://github.com/LSYS/texCheckmate/archive/refs/heads/main.zip
+```
+
+2. Unzip
+
+```bash
+unzip main.zip -d _contents
+```
+
+3. Move to ./
+```bash
+mv _contents/* .
+```
+
+
+