readme

LICENSE

@@ -0,0 +1,27 @@
+MIT License
+
+Copyright (c) 2024 William George Underwood
+
+Permission is hereby granted, free of charge, to any
+person obtaining a copy of this software and associated
+documentation files (the "Software"), to deal in the
+Software without restriction, including without
+limitation the rights to use, copy, modify, merge,
+publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software
+is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice
+shall be included in all copies or substantial portions
+of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF
+ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
+TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
+PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT
+SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
+IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+DEALINGS IN THE SOFTWARE.

README.md

@@ -1,2 +1,24 @@
 # tex-fmt
-Latex formatter written in Rust
+
+[![CI](
+https://github.com/wgunderwood/tex-fmt/actions/workflows/CI.yml/badge.svg)](
+https://github.com/wgunderwood/tex-fmt/actions/workflows/flake.yml)
+[![license: MIT](
+https://shields.io/badge/license-MIT-blue.svg)](
+https://mit-license.org/)
+
+A [LaTeX](https://www.latex-project.org/)
+formatter written in
+[Rust](https://www.rust-lang.org/)
+
+## Installation
+
+### Nix
+
+### Cargo
+
+## Aims
+
+This project aims to provide a command-line tool for formatting
+LaTeX source code files (`.tex`, `.bib`, `.cls`, `.sty`)
+with the following properties.