numtide/treefmt
Archived
8
0
Fork 0
Code Issues 1 Pull Requests Packages Projects Releases Wiki Activity

doc: refine quick start content

Browse Source 
Signed-off-by: Brian McGee <brian@bmcgee.ie>
This commit is contained in:
Brian McGee 2024-05-01 09:26:27 +01:00
parent 6c66daf26b
commit 577c6086c0
Signed by: brianmcgee
GPG Key ID: D49016E76AD1E8C0
1 changed files with 8 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/quick-start.md
View File

@ -1,11 +1,15 @@
---
outline: none
---
# Quick start
To run `treefmt` in your project, please follow these steps:
1. [Install] the tool.
2. Install the needed formatters.
3. Run `treefmt --init`. This will generate the basic configuration file `treefmt.toml` containing the formatting rules.
4. Edit the configuration (see [here] how).
1. [Install] `treefmt`.
2. Install any formatters you wish to use with `treefmt`.
3. Run `treefmt --init` to generate a basic configuration file `treefmt.toml`.
4. Edit the configuration, adding formatters as desired. See [here] for more info on how to configure a formatter.
5. Run `treefmt` with the needed flags and options. You can check the supported options by executing `treefmt --help`.
In the following sections we will guide you through installing and configuring `treefmt` in detail.