search

rhaiscript / rhai

Rhai - An embedded scripting language for Rust.
https://crates.io/crates/rhai
Apache License 2.0
3.81k stars 179 forks source link

Documentation!() #15

Closed felipetesc closed 4 years ago

felipetesc commented 8 years ago

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!

matthiasbeyer commented 8 years ago

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 commented 7 years ago

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

KaiserKarel commented 4 years ago

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 commented 4 years ago

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 commented 4 years ago

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.