installation docs
Some checks failed
Book / test (pull_request) Has been cancelled
Rust / build (pull_request) Has been cancelled

This commit is contained in:
Jaroslaw Konik 2025-05-27 17:51:14 +02:00
parent 97b448d6f4
commit 3e6e14fa71

View file

@ -1,5 +1,33 @@
# Installation
## Ruby
To build `bevy_scriptum` with Ruby support a Ruby installation is needed to be
present on your development machine.
The easiest way to produce a compatible Ruby installation is to use [rbenv](https://rbenv.org/).
After installing `rbenv` along with its `ruby-build` plugin you can build and
install a Ruby installation that will work with `bevy_scriptum` by executing:
```sh
CC=clang rbenv install 3.4.4
```
Above assumes that you also have `clang` installed on your system.
For `clang` installation instruction consult your
Linux distribution or [clang official webiste](https://clang.llvm.org).
If you rather not use `rbenv` you are free to supply your own installation of
Ruby provided the following is true about it:
- it is compiled with `clang`
- it is compiled as a static library
- it is accessible as `ruby` within `PATH` or `RUBY` environment variable is set
to path of desired `ruby` binary.
## Main Library
Add the following to your `Cargo.toml`:
```toml