Skip to content

Update readmes #10

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ikripaka merged 1 commit into from
Aug 24, 2026
Merged

Update readmes #10

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ In general, it uses `--check` instructs `simfmt` to exit with an error code if t

### Running `simfmt` from your editor

* [Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=Blockstream.simplicityhl)
* [Visual Studio Code][2]

### Configuring `simfmt`

Expand Down Expand Up @@ -131,4 +131,5 @@ Simfmt is distributed under the terms of both the MIT license.
See [MIT license](LICENSE) for details.


[1]: https://simplicity-lang.org/
[1]: https://simplicity-lang.org/
[2]: [https://simplicity-lang.org/](https://marketplace.visualstudio.com/items?itemName=Blockstream.simplicityhl)
5 changes: 3 additions & 2 deletions crates/cli/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,7 @@ $ simfmt --emit files contract.simf
## Editor integration

[SimplicityHL][1] formatting is available through the
[Visual Studio Code extension](https://marketplace.visualstudio.com/items?itemName=Blockstream.simplicityhl).
[Visual Studio Code extension][3].

## Limitations

Expand All @@ -170,4 +170,5 @@ See the repository's [contribution guide](../../Contributing.md) and
`simfmt` is distributed under the [MIT License](../../LICENSE).

[1]: https://simplicity-lang.org/
[2]: [https://simplicity-lang.org/](https://github.com/BlockstreamResearch/simfmt/blob/master/.github/scripts/simfmt-check)
[2]: [https://simplicity-lang.org/](https://github.com/BlockstreamResearch/simfmt/blob/master/.github/scripts/simfmt-check)
[3]: https://marketplace.visualstudio.com/items?itemName=Blockstream.simplicityhl
12 changes: 0 additions & 12 deletions crates/prettysimf/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,18 +34,6 @@ users:
* line width;
* newline style.

## Errors

`pretty_simf_please` returns one of three `PrettySimfError` variants:

* `Operational` means the formatter could not complete an operational step.
* `FormatError` means the input could not be parsed or formatted safely; its
message contains the formatter diagnostics.
* `StringConversion` means the formatted output unexpectedly contained invalid
UTF-8.

The in-memory API has the same [formatter limitations][2] as the `simfmt` CLI.

## Driver API

The `prettysimf::driver` module exposes the shared configuration types, runtime
Expand Down