Fix typo and add badge

Fix typo and add badge

Signed-off-by: Bensuperpc <bensuperpc@gmail.com>
This commit is contained in:
Bensuperpc 2021-08-07 16:48:59 +02:00
parent 8e6dd7e657
commit 73cbb14ba1

View File

@ -1,10 +1,9 @@
# dockcross # dockcross
Cross compiling toolchains in Docker images. Cross compiling toolchains in Docker images.
[![image](https://github.com/dockcross/dockcross/workflows/Dockcross%20CI/badge.svg)](https://github.com/dockcross/dockcross/actions?query=branch%3Amaster) [![image](https://github.com/dockcross/dockcross/workflows/Dockcross%20CI/badge.svg)](https://github.com/dockcross/dockcross/actions?query=branch%3Amaster) [![Shellcheck CI](https://github.com/dockcross/dockcross/actions/workflows/shellcheck.yml/badge.svg)](https://github.com/dockcross/dockcross/actions/workflows/shellcheck.yml)
## Features ## Features
@ -46,22 +45,17 @@ bash -c "<command args>"
## Installation ## Installation
This image does not need to be run manually. Instead, there is a helper This image does not need to be run manually. Instead, there is a helper script to execute build commands on source code existing on the local host filesystem. This script is bundled with the image.
script to execute build commands on source code existing on the local
host filesystem. This script is bundled with the image.
To install the helper script, run one of the images with no arguments, To install the helper script, run one of the images with no arguments, and redirect the output to a file:
and redirect the output to a file:
docker run --rm CROSS_COMPILER_IMAGE_NAME > ./dockcross docker run --rm CROSS_COMPILER_IMAGE_NAME > ./dockcross
chmod +x ./dockcross chmod +x ./dockcross
mv ./dockcross ~/bin/ mv ./dockcross ~/bin/
Where **CROSS_COMPILER_IMAGE_NAME** is the name of the Where **CROSS_COMPILER_IMAGE_NAME** is the name of the cross-compiler toolchain Docker instance, e.g: **dockcross/linux-armv7**.
cross-compiler toolchain Docker instance, e.g: **dockcross/linux-armv7**.
Only 64-bit x86_64 images are provided; a 64-bit x86_64 host system is Only 64-bit x86_64 images are provided; a 64-bit x86_64 host system is required.
required.
## Usage ## Usage
@ -72,17 +66,11 @@ For the impatient, here\'s how to compile a hello world for armv7:
chmod +x ./dockcross-linux-armv7 chmod +x ./dockcross-linux-armv7
./dockcross-linux-armv7 bash -c '$CC test/C/hello.c -o hello_arm' ./dockcross-linux-armv7 bash -c '$CC test/C/hello.c -o hello_arm'
Note how invoking any toolchain command (make, gcc, etc.) is just a Note how invoking any toolchain command (make, gcc, etc.) is just a matter of prepending the **dockcross** script on the commandline:
matter of prepending the **dockcross** script on the commandline:
./dockcross-linux-armv7 [command] [args...] ./dockcross-linux-armv7 [command] [args...]
The dockcross script will execute the given command-line inside the The dockcross script will execute the given command-line inside the container, along with all arguments passed after the command. Commands that evaluate environmental variables in the image, like **$CC** or **$CXX** above, should be executed in [bash -c]. The present working directory is mounted within the image, which can be used to make source code available in the Docker container.
container, along with all arguments passed after the command. Commands
that evaluate environmental variables in the image, like
**$CC** or **$CXX** above, should be executed in [bash -c].
The present working directory is mounted within the image, which can be
used to make source code available in the Docker container.
## Summary cross compilers ## Summary cross compilers
@ -129,8 +117,7 @@ used to make source code available in the Docker container.
![Docker Image Size (tag)](https://img.shields.io/docker/image-size/dockcross/base/latest) ![Docker Pulls](https://img.shields.io/docker/pulls/dockcross/base) ![Docker Stars](https://img.shields.io/docker/stars/dockcross/base) ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/dockcross/base/latest) ![Docker Pulls](https://img.shields.io/docker/pulls/dockcross/base) ![Docker Stars](https://img.shields.io/docker/stars/dockcross/base)
Base image for other toolchain images. From Debian Jessie with GCC, Base image for other toolchain images. From Debian Jessie with GCC, make, autotools, CMake, Ninja, Git, and Python.
make, autotools, CMake, Ninja, Git, and Python.
### dockcross/android-arm ### dockcross/android-arm