-
Notifications
You must be signed in to change notification settings - Fork 48
Update README.md to point out rust-simplicity and simplicity-hl #307
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.
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
base: master
Are you sure you want to change the base?
Conversation
also linked to Github discussions and Telegram group
README.md
Outdated
| Simplicity is a blockchain programming language designed as an alternative to Bitcoin script. | ||
|
|
||
| The language and implementation is still under development. | ||
| The language and implementation is still under development. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In 0f09100:
There is a trailing space at the end of this line.
README.md
Outdated
| The language and implementation is still under development. | ||
| The language and implementation is still under development. | ||
|
|
||
| It's recommended to start with [SimplicityHL](https://github.com/BlockstreamResearch/SimplicityHL) which looks and feels like Rust and compiles down to Simplicity Bytecode. There is also [rust-simplicity](https://github.com/BlockstreamResearch/rust-simplicity), a general purpose library for processing Simplicity programs. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In 0f09100:
Recommend using active language -- "We recommend starting with". And I guess we should justify it a little bit. Suggested rewording:
Simplicity is a very low-level language. This repository contains the consensus code implementation, an experimental Haskell library, the tech report and the a Rocq library for producing formal proofs. We recommend that users who just want to *use* Simplicity start with [SimplicityHL](https://github.com/BlockstreamResearch/SimplicityHL) which looks and feels like Rust and compiles down to Simplicity. There is also [rust-simplicity](https://github.com/BlockstreamResearch/rust-simplicity), a general purpose library for processing Simplicity programs.
(Also dropped the word "bytecode" since technically speaking, Simplicity's encoding is bit-aligned, not byte-aligned.)
|
Bump - @imaginator if you get a sec can you update this PR? |
|
@apoelstra I missed this. Updated now. |
|
Sorry, I didn't fetch. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
utACK 2d9a6d9
Documentation only change, the CI failures are unrelated to this change
|
utACK 2d9a6d9 I can do a real ACK but it will likely take a couple days since I need to rebuild the divsteps derivation before I can test PRs this repo. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ACK 2d9a6d9; successfully ran local tests
also linked to Github discussions and Telegram group