add some linter/formatter stuff to readme

AstroBarker · Feb 14, 2024 · 3526c54 · 3526c54
1 parent 90b9a6b
commit 3526c54
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -41,3 +41,5 @@ pressure = bmk_solution.p # see also bmk_solution.f for similarity variable
 # Code Style
 Code linting and formatting is done with [ruff](https://docs.astral.sh/ruff/).
 Rules are listed in [ruff.toml](ruff.toml).
+To check all python in the current directory, you may `ruff .`.
+To format a given file according to `ruff.toml`, run `ruff format file.py`.