Skip to content

Commit

Permalink
doc: refine quick start content
Browse files Browse the repository at this point in the history
Signed-off-by: Brian McGee <brian@bmcgee.ie>
  • Loading branch information
brianmcgee committed May 2, 2024
1 parent 6c66daf commit 577c608
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions docs/quick-start.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down

0 comments on commit 577c608

Please sign in to comment.