Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Hubro committed May 3, 2023
1 parent 5db5864 commit 05bf8e1
Showing 1 changed file with 4 additions and 8 deletions.
12 changes: 4 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,14 @@ YANG code formatter

## Install

If you have the Rust toolchain installed:
Download the correct pre-compiled binary for your system from [Releases](https://github.com/Hubro/yangfmt/releases).

Alternatively, if you have the Rust toolchain installed:

```
$ cargo install yangfmt
```

Pre-compiled binaries will be provided soon.

## Usage

Pipe YANG source code to STDIN:
Expand Down Expand Up @@ -43,10 +43,6 @@ TODO:

- [ ] Automatically sort statements to comply with the canonical order (maybe behind a feature flag?)

- [ ] Better error messages, currently syntax errors are reported raw with a character index

Instead, error messages should show the file name, line number and column number, plus details about the error.

- [ ] Fix all corner case crashes

The [YangModels] repository contains over 80 000 YANG models (totalling over 2.2 GB). When running the formatter on
Expand All @@ -61,7 +57,7 @@ TODO:

Fortunately I've never seen anybody do this, but it's legal YANG so it should be supported.

[YandModels]: https://github.com/YangModels/yang
[YangModels]: https://github.com/YangModels/yang

## Ideas

Expand Down

0 comments on commit 05bf8e1

Please sign in to comment.