Skip to content

Commit

Permalink
Outline the important parts of the YAML.
Browse files Browse the repository at this point in the history
Also add the dylibs feature since it is required.
  • Loading branch information
wmedrano committed Jan 20, 2024
1 parent 59ed54f commit d5ff740
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions docs/src/start/dylib.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,12 @@ This should create a directory structure as follows:
│   └── lib.rs
```

We'll want to make this a `cdylib` library, so we'll adjust the `Cargo.toml` as
follows:
We'll want to make this a `cdylib` library for Steel, so we'll perform the following adjustments in `Cargo.toml`:

1. Set the `crate-type` to `"cdylib"`.
1. Include `steel-core` with the `dylibs` feature as a dependency.
1. Include `abi_stable` as a dependency. This is required by some `steel-core`
macros.

```toml
[package]
Expand All @@ -51,7 +55,7 @@ crate-type = ["cdylib"]
[dependencies]
# I'm running this example based on the `steel-sys-info` library found in the steel repo. If you're
# running this on your own, use whichever steel version you'd like to target and pin to that.
steel-core = { workspace = true }
steel-core = { workspace = true, features = ["dylibs"] }
abi_stable = "0.11.1"
sys-info = "0.9.1"
```
Expand Down

0 comments on commit d5ff740

Please sign in to comment.