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

Document how to use Eyra with -Zbuild-std. #12

Merged
merged 1 commit into from
Oct 8, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,23 @@ Known limitations in `Eyra` include:
- Many libc C functions that aren't typically needed by most Rust programs
aren't implemented yet.

## Compatibility with `-Zbuild-std`

Eyra works with `-Zbuild-std`, however the `std` trick used above doesn't work,
so it's necessary to instead use this `cargo add` invocation:

```console
cargo add eyra
```

and to also add this line to the program's `main.rs` file:

```rust,no_run
extern crate eyra;
```

to ensure that the Eyra libraries are linked in.

## Background

Eyra is similar to [Mustang] and uses the same underlying code, but instead
Expand Down