numtide/treefmt
1
1
Fork 0
mirror of https://github.com/numtide/treefmt.git synced 2024-10-03 20:18:11 +03:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: focus on the default experience in the quickstart

Browse Source 
Most of the time you don't need the extra running options.
This commit is contained in:
zimbatm 2024-05-30 14:09:42 +02:00
parent 93955bbc3c
commit fccb46367c
1 changed files with 1 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
docs/quick-start.md
View File

@ -10,8 +10,7 @@ To run `treefmt` in your project, follow these steps:
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` with the needed [flags & options].
5. Run `treefmt` anywhere in your project to format the whole tree.
[install]: install
[configuring]: configure
[flags & options]: usage