Skip to content

Commit

Permalink
Document how to use Eyra with -Zbuild-std. (#12)
Browse files Browse the repository at this point in the history
  • Loading branch information
sunfishcode authored Oct 8, 2023
1 parent 91fc6e4 commit 1794164
Showing 1 changed file with 17 additions and 0 deletions.
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

0 comments on commit 1794164

Please sign in to comment.