aboutsummaryrefslogtreecommitdiffstatshomepage
diff options
context:
space:
mode:
authorEgor Tensin <Egor.Tensin@gmail.com>2021-01-17 16:20:11 +0300
committerEgor Tensin <Egor.Tensin@gmail.com>2021-01-17 16:20:11 +0300
commit254786b6846bd59f5118a75456f184c36e86a3dc (patch)
tree3ef46eb1897337c5ec1203dfaa197d67ebc2817b
parentfix .clang-format (diff)
downloadcmake-common-254786b6846bd59f5118a75456f184c36e86a3dc.tar.gz
cmake-common-254786b6846bd59f5118a75456f184c36e86a3dc.zip
README: update
-rw-r--r--README.md28
-rw-r--r--project/toolchain.py25
2 files changed, 43 insertions, 10 deletions
diff --git a/README.md b/README.md
index a6f8271..9041ac6 100644
--- a/README.md
+++ b/README.md
@@ -105,6 +105,34 @@ Environment variables:
$ python3 path/to/tools/clang-format.py # Prints a diff
$ python3 path/to/tools/clang-format.py -i # Edits files in-place
+Toolchains
+----------
+
+Supported platform/build system/compiler combinations include, but are not
+limited to:
+
+| Platform | Build system | Compiler
+| -------- | ------------ | --------
+| Linux | make | Clang
+| | | GCC
+| | | MinGW-w64
+| Windows | make \[1\] | Clang (clang/clang++)
+| | | Clang (clang-cl \[2\])
+| | | MinGW-w64
+| | msbuild | MSVC
+| Cygwin | make | Clang
+| | | GCC
+| | | MinGW-w64
+
+1. Both GNU `make` and MinGW `mingw32-make`.
+2. Boost 1.69.0 or higher only.
+
+All of those are verified continuously by the "Boost (toolsets)" and "Examples
+(toolsets)" workflows.
+
+[![Examples (toolsets)](https://github.com/egor-tensin/cmake-common/workflows/Examples%20(toolsets)/badge.svg)](https://github.com/egor-tensin/cmake-common/actions?query=workflow%3A%22Examples+%28toolsets%29%22)
+[![Boost (toolsets)](https://github.com/egor-tensin/cmake-common/workflows/Boost%20(toolsets)/badge.svg)](https://github.com/egor-tensin/cmake-common/actions?query=workflow%3A%22Boost+%28toolsets%29%22)
+
Examples
--------
diff --git a/project/toolchain.py b/project/toolchain.py
index 4d10872..f92e536 100644
--- a/project/toolchain.py
+++ b/project/toolchain.py
@@ -6,16 +6,21 @@
'''Supported platform/build system/compiler combinations include, but are not
limited to:
-* Linux / make / Clang,
-* Linux / make / GCC,
-* Linux / make / MinGW-w64,
-* Windows / make / Clang (clang.exe & clang++.exe),
-* Windows / make / Clang (clang-cl.exe, Boost 1.69.0 or higher only),
-* Windows / make / MinGW-w64,
-* Windows / msbuild / MSVC,
-* Cygwin / make / Clang,
-* Cygwin / make / GCC,
-* Cygwin / make / MinGW-w64.
+| Platform | Build system | Compiler
+| -------- | ------------ | --------
+| Linux | make | Clang
+| | | GCC
+| | | MinGW-w64
+| Windows | make [1] | Clang (clang/clang++)
+| | | Clang (clang-cl [2])
+| | | MinGW-w64
+| | msbuild | MSVC
+| Cygwin | make | Clang
+| | | GCC
+| | | MinGW-w64
+
+1. Both GNU make and MinGW mingw32-make.
+2. Boost 1.69.0 or higher only.
'''
import argparse