Skip to content

Commit 869e59b

Browse files
committed
[README.md] initial draft
1 parent 3034dbb commit 869e59b

File tree

1 file changed

+29
-1
lines changed

1 file changed

+29
-1
lines changed

README.md

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,30 @@
11
# ufofmt
2-
A highly opinionated UFO source file formatter based on the Norad library
2+
3+
A highly opinionated UFO source file formatter based on the [Norad library](https://github.com/linebender/norad)
4+
5+
## Installation
6+
7+
```
8+
$ git clone https://github.com/source-foundry/ufofmt.git
9+
$ cd ufofmt && cargo install
10+
```
11+
12+
This installation process installs the `ufofmt` executable.
13+
14+
## Usage
15+
16+
Pass one or more UFO source directory paths to the `ufofmt` executable:
17+
18+
```
19+
$ ufofmt [UFO PATH 1] ... [UFO PATH N]
20+
```
21+
22+
To view total execution duration data, include the `--time` flag:
23+
24+
```
25+
$ ufofmt --time [UFO PATH 1] ... [UFO PATH N]
26+
```
27+
28+
## License
29+
30+
[Apache License v2.0](LICENSE)

0 commit comments

Comments
 (0)