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

Add documentation on how to setup the project #4

Open
2 tasks
smarr opened this issue Aug 16, 2017 · 1 comment
Open
2 tasks

Add documentation on how to setup the project #4

smarr opened this issue Aug 16, 2017 · 1 comment

Comments

@smarr
Copy link
Member

smarr commented Aug 16, 2017

Document how to:

  • use BD in an existing Truffle language
  • how to develop BD, use CI, etc
@ghost
Copy link

ghost commented Mar 2, 2018

To add to the list here, I think it would be great to have a bare-bones "hello world" style of example. Obviously, the example needs to be a full interpreter, so it's not going to that simple. However, I think it's important to have a simple starting point for new users. One option would be for us to fork Simple Language and replace the code with diamonds where we can.

I'm not sure if we will ever have enough free time at the same time, but perhaps we (@smarr, @charig, @daumayr, @Richard-Roberts) could do this together somehow - two people take notes while the other two people do the implementation. It shouldn't take too long (one weekend perhaps) and through doing this we generate good documentation?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant