numtide/treefmt
1
1
Fork 0
mirror of https://github.com/numtide/treefmt.git synced 2024-09-11 08:55:33 +03:00
Code Issues Actions Packages Projects Releases Wiki Activity
23e563b239
treefmt/docs/quick-start.md
Brian McGee d9f413a169
feat: simple versioned docs 
It's a little brute force,
but since we have a small amount of docs currently it should help us in the near term
to avoid
releasing doc updates for features that have not been released yet.

Signed-off-by: Brian McGee <brian@bmcgee.ie>
2024-07-04 14:40:41 +01:00

449 B
Raw Blame History

outline
none

Quick start

To run treefmt in your project, follow these steps:

  1. Install treefmt.
  2. Ensure any formatters you wish to use are also installed e.g. gofmt
  3. Run treefmt --init to generate a basic configuration file treefmt.toml.
  4. Edit treefmt.toml, configuring formatters as desired.
  5. Run treefmt anywhere in your project to format the whole tree.