numtide/treefmt
1
1
Fork 0
mirror of https://github.com/numtide/treefmt.git synced 2024-08-17 21:00:27 +03:00
Code Issues Actions Packages Projects Releases Wiki Activity
9934a5764d
treefmt/docs/quick-start.md
zimbatm fccb46367c docs: focus on the default experience in the quickstart 
Most of the time you don't need the extra running options.
2024-05-30 14:26:38 +02:00

443 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.