Skip to content

Commit

Permalink
README
Browse files Browse the repository at this point in the history
  • Loading branch information
WGUNDERWOOD committed Jan 12, 2025
1 parent bcefeaa commit b902d15
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 8 deletions.
12 changes: 4 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -230,9 +230,9 @@ directory for more details.

### Pre-commit hook

You can format your LaTeX files before every commit using
[pre-commit](http://pre-commit.com) with the following `.pre-commit-config.yaml`
in your repository root:
tex-fmt can be run before every git commit using
[pre-commit](http://pre-commit.com) with the following
`.pre-commit-config.yaml` in your repository root:

```yaml
repos:
Expand All @@ -242,17 +242,13 @@ repos:
- id: tex-fmt
```
If you don't only want to prevent committing on unformatted
documents but don't want them automatically formatted, add:
To prevent the pre-commit hook from modifying your files, add:
```yaml
- id: tex-fmt
args: [--check]
```
For more on how to use pre-commit check out their
[quick start guide](https://pre-commit.com/#quick-start)!
## Performance
When formatting all of the test cases,
Expand Down
1 change: 1 addition & 0 deletions notes.org
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
*** git log --oneline --no-merges vX.X.X..main
*** Write in NEWS.md
** Update version number in Cargo.toml
** Update version number for pre-commit
** Update Nix flake and lock
*** Check for new NixOS version (nixos-XX.XX) for flake.nix
*** just nix
Expand Down

0 comments on commit b902d15

Please sign in to comment.