2024-05-01 11:26:27 +03:00
|
|
|
---
|
|
|
|
|
outline: none
|
|
|
|
|
---
|
|
|
|
|
|
2024-04-29 14:32:00 +03:00
|
|
|
# Quick start
|
|
|
|
|
|
2024-05-10 12:17:49 +03:00
|
|
|
To run `treefmt` in your project, follow these steps:
|
2024-04-29 14:32:00 +03:00
|
|
|
|
2024-05-01 11:26:27 +03:00
|
|
|
1. [Install] `treefmt`.
|
2024-05-10 12:17:49 +03:00
|
|
|
2. Ensure any formatters you wish to use are also installed e.g. `gofmt`
|
2024-05-01 11:26:27 +03:00
|
|
|
3. Run `treefmt --init` to generate a basic configuration file `treefmt.toml`.
|
2024-05-10 12:17:49 +03:00
|
|
|
4. Edit `treefmt.toml`, [configuring] formatters as desired.
|
|
|
|
|
5. Run `treefmt` with the needed [flags & options].
|
2024-04-29 14:32:00 +03:00
|
|
|
|
2024-05-10 12:17:49 +03:00
|
|
|
[install]: install
|
|
|
|
|
[configuring]: configure
|
|
|
|
|
[flags & options]: usage
|
