Skip to content

Commit

Permalink
Merge #796
Browse files Browse the repository at this point in the history
796: Reference the wiki in the README. r=Emilgardis a=Alexhuszagh

Closes #723.

Co-authored-by: Alex Huszagh <ahuszagh@gmail.com>
  • Loading branch information
bors[bot] and Alexhuszagh authored Jun 14, 2022
2 parents 6a63e3a + edb0f2b commit 1aec883
Showing 1 changed file with 8 additions and 5 deletions.
13 changes: 8 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,12 +62,13 @@ $ cargo install cross --git https://github.com/cross-rs/cross
## Usage

`cross` has the exact same CLI as [Cargo](https://github.com/rust-lang/cargo)
but as it relies on Docker you'll have to start the daemon before you can use
it.
but as it relies on Docker or Podman. For Docker, you'll have to start
the daemon before you can use it.

```
# (ONCE PER BOOT)
# Start the Docker daemon, if it's not already running
# (ONCE PER BOOT, on Linux)
# Start the Docker daemon, if it's not already running using systemd
# on WSL2 and other systems using SysVinit, use `sudo service docker start`.
$ sudo systemctl start docker
# MAGIC! This Just Works
Expand All @@ -80,6 +81,8 @@ $ cross test --target mips64-unknown-linux-gnuabi64
$ cross rustc --target powerpc-unknown-linux-gnu --release -- -C lto
```

Additional documentation can be found on the [wiki](https://github.com/cross-rs/cross/wiki).

## Configuration

You can place a `Cross.toml` file in the root of your Cargo project or use a
Expand Down Expand Up @@ -128,7 +131,7 @@ $ docker build -t my/image:tag path/to/where/the/Dockerfile/resides

### Docker in Docker

When running `cross` from inside a docker container, `cross` needs access to
When running `cross` from inside a container, `cross` needs access to
the hosts docker daemon itself. This is normally achieved by mounting the
docker daemons socket `/var/run/docker.sock`. For example:

Expand Down

0 comments on commit 1aec883

Please sign in to comment.