doc: refine quick start content
Signed-off-by: Brian McGee <brian@bmcgee.ie>
This commit is contained in:
parent
0fd5107ea4
commit
44b9ea287a
|
@ -1,11 +1,15 @@
|
||||||
|
---
|
||||||
|
outline: none
|
||||||
|
---
|
||||||
|
|
||||||
# Quick start
|
# Quick start
|
||||||
|
|
||||||
To run `treefmt` in your project, please follow these steps:
|
To run `treefmt` in your project, please follow these steps:
|
||||||
|
|
||||||
1. [Install] the tool.
|
1. [Install] `treefmt`.
|
||||||
2. Install the needed formatters.
|
2. Install any formatters you wish to use with `treefmt`.
|
||||||
3. Run `treefmt --init`. This will generate the basic configuration file `treefmt.toml` containing the formatting rules.
|
3. Run `treefmt --init` to generate a basic configuration file `treefmt.toml`.
|
||||||
4. Edit the configuration (see [here] how).
|
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`.
|
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.
|
In the following sections we will guide you through installing and configuring `treefmt` in detail.
|
||||||
|
|
Reference in New Issue
Block a user