From 1866b6935675903b0256c0ded490c51968fa2bd0 Mon Sep 17 00:00:00 2001 From: Bensuperpc Date: Sun, 8 Aug 2021 20:58:04 +0200 Subject: [PATCH] Fix readme Fix readme Signed-off-by: Bensuperpc --- README.md | 20 ++++++-------------- 1 file changed, 6 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index c0de382..9fd80c6 100644 --- a/README.md +++ b/README.md @@ -14,33 +14,25 @@ Cross compiling toolchains in Docker images. - Clean separation of build tools, source code, and build artifacts. - Commands in the container are run as the calling user, so that any created files have the expected ownership, (i.e. not root). -- Make variables ([CC]{.title-ref}, [LD]{.title-ref} etc) are set to +- Make variables **CC**, **CXX**, **LD** etc) are set to point to the appropriate tools in the container. - Recent [CMake](https://cmake.org) and ninja are precompiled. - [Conan.io](https://www.conan.io) can be used as a package manager. - Toolchain files configured for CMake. - Current directory is mounted as the container\'s workdir, `/work`. -- Works with the [Docker for - Mac](https://docs.docker.com/docker-for-mac/) and [Docker for - Windows](https://docs.docker.com/docker-for-windows/). -- Support using alternative container executor by setting - [OCI_EXE]{.title-ref} environment variable. By default, it searches +- Works with the [Docker for Mac](https://docs.docker.com/docker-for-mac/) and [Docker for Windows](https://docs.docker.com/docker-for-windows/). +- Support using alternative container executor by setting **OCI_EXE** environment variable. By default, it searches for [docker]{.title-ref} and [podman](https://podman.io) executable. ## Examples 1. `dockcross make`: Build the *Makefile* in the current directory. -2. `dockcross cmake -Bbuild -H. -GNinja`: Run CMake with a build - directory `./build` for a *CMakeLists.txt* file in the current - directory and generate `ninja` build configuration files. +2. `dockcross cmake -Bbuild -H. -GNinja`: Run CMake with a build directory `./build` for a *CMakeLists.txt* file in the current directory and generate `ninja` build configuration files. 3. `dockcross ninja -Cbuild`: Run ninja in the `./build` directory. -4. `dockcross bash -c '$CC test/C/hello.c -o hello'`: Build the - *hello.c* file with the compiler identified with the `CC` - environmental variable in the build environment. +4. `dockcross bash -c '$CC test/C/hello.c -o hello'`: Build the *hello.c* file with the compiler identified with the `CC` environmental variable in the build environment. 5. `dockcross bash`: Run an interactive shell in the build environment. -Note that commands are executed verbatim. If any shell processing for -environment variable expansion or redirection is required, please use +Note that commands are executed verbatim. If any shell processing for environment variable expansion or redirection is required, please use ```bash bash -c "" ```