rhai/doc/src/start/install.md
Stephen Chung d6a08be223 Refactor.
2020-06-29 23:55:28 +08:00

30 lines
877 B
Markdown

Install the Rhai Crate
=====================
{{#include ../links.md}}
In order to use Rhai in a project, the Rhai crate must first be made a dependency.
The easiest way is to install the Rhai crate from [`crates.io`](https:/crates.io/crates/rhai/),
starting by looking up the latest version and adding this line under `dependencies` in the project's `Cargo.toml`:
```toml
[dependencies]
rhai = "{{version}}" # assuming {{version}} is the latest version
```
Or to automatically use the latest released crate version on [`crates.io`](https:/crates.io/crates/rhai/):
```toml
[dependencies]
rhai = "*"
```
Crate versions are released on [`crates.io`](https:/crates.io/crates/rhai/) infrequently,
so to track the latest features, enhancements and bug fixes, pull directly from GitHub:
```toml
[dependencies]
rhai = { git = "https://github.com/jonathandturner/rhai" }
```