doc: initial port of README
Signed-off-by: Brian McGee <brian@bmcgee.ie>
This commit is contained in:
parent
f5c81e64ec
commit
09e80a2cb1
16
README.md
16
README.md
|
@ -34,17 +34,19 @@ Its main features are:
|
||||||
|
|
||||||
- **Providing a unified CLI and output**
|
- **Providing a unified CLI and output**
|
||||||
- You don’t need to remember which formatters are necessary for each project.
|
- You don’t need to remember which formatters are necessary for each project.
|
||||||
Once you specify the formatters in the config file, you can trigger all of them with one command and get a
|
- Once you specify the formatters in the config file, you can trigger all of them with one command and get a
|
||||||
standardized output.
|
standardized output.
|
||||||
- **Running all the formatters in parallel**
|
- **Running all the formatters in parallel**
|
||||||
- A standard script loops over your folders and runs each formatter
|
- A standard script loops over your folders and runs each formatter sequentially.
|
||||||
consequentially. In contrast, `treefmt` runs formatters in parallel. This way, the formatting job takes less time.
|
- In contrast, `treefmt` runs formatters in parallel. This way, the formatting job takes less time.
|
||||||
- **Tracking file changes**
|
- **Tracking file changes**
|
||||||
- When formatters are run in a script, they process all the files they encounter, no matter
|
- When formatters are run in a script, they process all the files they encounter, regardless of whether or not
|
||||||
whether the code has changed. This unnecessary work can be eliminated if only the changed files are formatted.
|
they have changed.
|
||||||
`treefmt` caches the changed files and marks them for re-formatting.
|
- `treefmt` tracks file changes, and only attempts to format files which have changed.
|
||||||
|
|
||||||
To reformat the whole source tree, just type `treefmt` in any folder. This is a fast and simple formatting solution.
|
To reformat the whole source tree, just type `treefmt` in any folder.
|
||||||
|
|
||||||
|
This is a fast and simple formatting solution.
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
|
|
Reference in New Issue
Block a user