rewrite README.md #302
Merged
rewrite README.md #302
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Collaborator
Author
|
cc @imaginator @roconnor-blockstream Also cc @sanket1729 @uncomputable in case you have opinions and are willing to take the time to review this. |
apoelstra
force-pushed
the
2025-08/readme
branch
4 times, most recently
from
0d89271 to
30716ca
Compare
roconnor-blockstream
suggested changes
Aug 11, 2025
README.md
Outdated
| This is the official Rust library of the [Simplicity Language](https://simplicity-lang.org/). | ||
|
|
||
| The MSRV of this crate is **1.78.0**. | ||
| Simplicity is a low-level, typeed functional language designed to be a drop-in replacement |
Contributor
There was a problem hiding this comment.
Not replacement but more like alternative.
Collaborator
Author
There was a problem hiding this comment.
Sure, I think "drop-in alternative" reads ok. I agree that "replacement" is too agressive a term.
README.md
Outdated
| - cross-validating the C and Rust Bit Machine implementations | ||
|
|
||
| The libsimplicity repository also contains: | ||
| - A Haskell library with similar goals to rust-simplicity |
Contributor
There was a problem hiding this comment.
While this is not wrong, I think it is better to have folks think of the Haskell library as a reference implementation instead. Indeed we generate some Rust code from this reference.
apoelstra
force-pushed
the
2025-08/readme
branch
from
30716ca to
3b62bdf
Compare
canndrew
reviewed
Aug 12, 2025
README.md
Outdated
| This is the official Rust library of the [Simplicity Language](https://simplicity-lang.org/). | ||
|
|
||
| The MSRV of this crate is **1.78.0**. | ||
| Simplicity is a low-level, typeed functional language designed to be a drop-in alternative |
Collaborator
|
LGTM, other than that one typo. |
With suggestions and rewording from Claude 4.
apoelstra
force-pushed
the
2025-08/readme
branch
from
3b62bdf to
c8602cf
Compare
Collaborator
Author
|
Gonna go ahead and merge this. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
With suggestions and rewording from Claude 4.
The next PR will attempt to fill in the top-level library docs which appear on docs.rs, including more useful simple example programs.