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

Documentation!() #15

Closed
felipetesc opened this issue Sep 23, 2016 · 5 comments
Closed

Documentation!() #15

felipetesc opened this issue Sep 23, 2016 · 5 comments

Comments

@felipetesc
Copy link

Great job!
By simply looking the readme file, I found that your job seems very promissing, and I'll, just like many other people, ask you more documentation. I've looked into the project dates, and as I can see, you are changing it constantly: that's good. I really wanted to use your Script System, but I found a little bit hard with the current state of your examples(docs). It would be nice, if you create a document showing to the people the differences between Rhai to Rust. So if we study Rust, and later on, we can study your language! Presenting a table with the diffrences between the both (Rust and Rhai) may be enough.
Thanks and keep doing it!

@sophiajt sophiajt mentioned this issue Oct 21, 2016
3 tasks
@matthiasbeyer
Copy link

Jup, can't support this enough. I am about to integrate rhai into my project (imag) and I'd love some more documentation and also generated github pages!

@luciusmagn
Copy link
Collaborator

Oh yeah, docs are good. I will add it to TODO and hopefully work on them in the near future

@KaiserKarel
Copy link

KaiserKarel commented Apr 7, 2020

Should we have a Rhai book, mimicing https://doc.rust-lang.org/stable/book/ch01-02-hello-world.html? Probably best post v1.0, once the language and features stabilize a bit. It would be nice to document rhai features, and how to implement these from the host's, side-by-side.

@schungx
Copy link
Collaborator

schungx commented Apr 7, 2020

I'm all for more documentation, but as typical for release-quality software, you spend 1 hr writing code and then 5 hours writing documentation and tests and examples...

Somebody needs to come up with the time to gradually do this, I suppose...

@schungx
Copy link
Collaborator

schungx commented Jun 2, 2020

Closing this one for now. I feel that at least the README has improved to an extent that it should be usable, although still light on examples and tutorials.

@schungx schungx closed this as completed Jun 2, 2020
alvinhochun pushed a commit to alvinhochun/rhai that referenced this issue Jul 5, 2020
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

5 participants