# remy: *sous-chef de métro*
# EXAMPLE
```console
$ cd example
$ remy hello
$ tree target/bin
target/bin
├── arm-unknown-linux-gnueabi
│ └── hello
├── i686-unknown-linux-gnu
│ └── hello
├── wasm32-unknown-unknown
│ └── hello.wasm
├── x86_64-unknown-cloudabi
│ └── hello
└── x86_64-unknown-linux-gnu
└── hello
```
Target types can be skipped with `-e <pattern>`, e.g. `-e cloudabi`.
See `remy -h` for more details.
# ABOUT
remy quickly generates Rust ports for multiple target environments, by running your Rust project through an array of Docker containers for different target toolchains.
# DOWNLOADS
https://github.com/mcandre/remy/releases
# CRATE
https://crates.io/crates/remy
# API DOCUMENTATION
https://docs.rs/releases/search?query=remy
# RUNTIME REQUIREMENTS
* [Cargo](https://www.rust-lang.org/en-US/)
* [Docker](https://www.docker.com/)
## Recommended
* [tree](https://linux.die.net/man/1/tree)
# INSTALL
```console
$ cargo install remy
```
# USAGE
1. Define any custom linkers in `.cargo/config`. See the included [example](example) project for more information.
2. Run `remy` with your project's binary names as arguments.
3. remy products ports in the structure `target/bin/<environment>/<binary>`.
# CONTRIBUTING
For more details on developing remy itself, see [DEVELOPMENT.md](DEVELOPMENT.md).
# SEE ALSO
* [cartel](https://github.com/mcandre/cartel) provides Docker images for C/C++ cross-compilation toolchains
* [goxcart](https://github.com/mcandre/goxcart) generates Go application ports based on the standard Go toolchain
* [tonixxx](https://github.com/mcandre/tonixxx) provides a more heavyweight solution using virtual machines
* [trust](https://github.com/japaric/trust) integrates CI systems with Rust ports.
