Skip to content

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.

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update README.md to point out rust-simplicity and simplicity-hl #307

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
9 changes: 6 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,9 @@

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.
Copy link
Contributor

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.


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.
Copy link
Contributor

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.)


## Contents

Expand Down Expand Up @@ -191,5 +193,6 @@ A recent PDF version can be found in the [pdf](https://github.com/ElementsProjec

## Contact

Interested parties are welcome to join the [Simplicity mailing list](https://lists.ozlabs.org/listinfo/simplicity).
Issues and pull-requests can be made through GitHub's interface.
Discussions are hosted on [Github discussions](https://github.com/BlockstreamResearch/simplicity/discussions), and there's a [Simplicity Telegram Community](https://t.me/simplicity_community).

We welcome issues and pull-requests.
Loading