From 1ada668d0f7a61d268ed3387649e5be8b8d7498d Mon Sep 17 00:00:00 2001 From: William G Underwood <42812654+WGUNDERWOOD@users.noreply.github.com> Date: Fri, 26 Apr 2024 14:50:47 -0400 Subject: [PATCH] readme --- README.md | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 06d0d86..993e6f3 100644 --- a/README.md +++ b/README.md @@ -20,5 +20,17 @@ formatter written in ## Aims This project aims to provide a command-line tool for formatting -LaTeX source code files (`.tex`, `.bib`, `.cls`, `.sty`) -with the following properties. +LaTeX source code files with the following properties. + +- Handling of common file types: `.tex`, `.bib`, `.cls`, `.sty` +- Very good run-time performance +- Basic configuration options +- Sensible defaults + +It does *not* currently aim to provide the following: + +- Semantic parsing of LaTeX code +- Linting or correction of syntax errors +- Compliance with any existing formatting guidelines +- Editor integration +- Spell checking