Document XBUILD_SYSROOT_PATH in README.md

rust-osdev / cargo-xbuild

Automatically cross-compiles the sysroot crates core, compiler_builtins, and alloc.

Apache License 2.0

260 stars 25 forks source link

Document XBUILD_SYSROOT_PATH in README.md #35

Closed Nils-TUD closed 5 years ago

Nils-TUD commented 5 years ago

The README currently only describes that the sysroot path can be modified in the Cargo.toml. Unfortunately, this approach doesn't work if a workspace is used, because this results in many packages in the metadata and cargo-xbuild always searches for its options in the first package.

It just took me several hours to figure out that this is the problem and that there actually is an alternative: the XBUILD_SYSROOT_PATH environment variable. Please document that in the README ;)

phil-opp commented 5 years ago

Thanks for reporting! I added the missing documentation in 994b5e7.