Skip to content
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

Crust Language Reference #1

Closed
wants to merge 2 commits into from
Closed

Crust Language Reference #1

wants to merge 2 commits into from

Conversation

mkaput
Copy link
Member

@mkaput mkaput commented May 24, 2022

Crust IS A TEMPORARY NAME

This PR adds The Crust Language Reference, a document which specifies the language we want to develop.

The whole book is added at once, so context is easily visible. Please review and discuss it file-by-file as each file describes a separate chapter. (I think GitHub reviews may be better tool here because of the easily accessible Viewed checkbox)

To run this book locally, install mdBook and run mdbook serve. You will also need Python 3.10. See readme for more details.

Feel free to add any interested people as reviewers, the more feedback the better.


This change is Reviewable

@mkaput mkaput added the documentation Improvements or additions to documentation label May 24, 2022
@mkaput mkaput marked this pull request as draft May 24, 2022 07:59
@mkaput mkaput force-pushed the mkaput/language-reference branch from 689eb53 to f76ad72 Compare May 24, 2022 08:00
@orizi
Copy link
Collaborator

orizi commented May 24, 2022

Since crust isn't actually the name of the language - and @liorgold2 did say that we don't want to have in the final public record things that are entirely incorrect - so i think we should either search and replace 'crust' to something more impartial like 'cairo2', or just state in a very major way that crust is a placeholder.

@mkaput
Copy link
Member Author

mkaput commented May 24, 2022

Yep, I will emphasize that Crust is a temporary name

Comment on lines +6 to +7
This document itself has also been largely based on [The Rust Reference] and many definitions have
been borrowed from it.
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I will emphasize that I have allowed myself to copy paragraphs or sentences from Rust Language Reference. It's an open source document and in order to acknowledge their work I have added information about this to the Influences page.

I'm not a lawyer, is there a chance that this note will require something more explicit?

@mkaput
Copy link
Member Author

mkaput commented Aug 16, 2022

Closing in favor of #37

@mkaput mkaput closed this Aug 16, 2022
shramee referenced this pull request in shramee/cairo Feb 4, 2023
* refactor: import dojo plugin

* feat: dojo compiler db plugin

* feat: impl syscall/serde for Position

* feat: add compile module (starkware-libs#2)

* Compile module

* Use compile module for CLI

* Cleanup `use`es

---------

Co-authored-by: Shramee Srivastav <shramee.srivastav@gmail.com>
@orizi orizi deleted the mkaput/language-reference branch March 30, 2023 13:57
shramee referenced this pull request in shramee/cairo Sep 5, 2023
@avocadodefi avocadodefi mentioned this pull request Dec 26, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants