Skip to content

Commit

Permalink
readme
Browse files Browse the repository at this point in the history
  • Loading branch information
WGUNDERWOOD committed Apr 26, 2024
1 parent 4d7faa3 commit 1ada668
Showing 1 changed file with 14 additions and 2 deletions.
16 changes: 14 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

0 comments on commit 1ada668

Please sign in to comment.