aboutsummaryrefslogtreecommitdiffstatshomepage
diff options
context:
space:
mode:
authorEgor Tensin <Egor.Tensin@gmail.com>2023-07-04 00:24:37 +0200
committerEgor Tensin <Egor.Tensin@gmail.com>2023-07-04 00:24:37 +0200
commit0e35c671fecaad258bb8720867653389da642039 (patch)
treedcf6031fb606bc60503fc6202ae93514ccbbf21f
parentcommon.cmake: refactoring (diff)
downloadcmake-common-0e35c671fecaad258bb8720867653389da642039.tar.gz
cmake-common-0e35c671fecaad258bb8720867653389da642039.zip
README & --help message updates
Diffstat (limited to '')
-rw-r--r--README.md13
-rw-r--r--project/boost/build.py7
-rw-r--r--project/boost/download.py3
-rw-r--r--project/build.py11
4 files changed, 24 insertions, 10 deletions
diff --git a/README.md b/README.md
index 2738964..70b963f 100644
--- a/README.md
+++ b/README.md
@@ -7,6 +7,15 @@ cmake-common
Utilities to help develop C++/CMake projects.
+Description
+-----------
+
+This main goal of this project is to make it easier to build (potentially,
+cross-compile) Boost and CMake projects using different toolsets.
+It does so providing a set of command-line utilities that allow users to
+download/build Boost & use it in a CMake project in a consistent way &mdash; no
+matter the compiler or the target platform.
+
Installation
------------
@@ -95,10 +104,10 @@ in CMakeLists.txt.
This file aids in quick-and-dirty development by
* linking everything (including the runtime) statically by default,
-* setting some useful compilation options (enables warnings, defines useful
+* setting some useful compilation options (enables warnings, defines common
Windows-specific macros, strips debug symbols in release builds, etc.).
-Everything is optional (use the `CC_*` CMake options to opt out).
+Everything is enabled by default (use the `CC_*` CMake options to opt out).
Tools
-----
diff --git a/project/boost/build.py b/project/boost/build.py
index bd4fd6b..a29fb29 100644
--- a/project/boost/build.py
+++ b/project/boost/build.py
@@ -5,8 +5,11 @@
R'''Build Boost.
-This script builds the Boost libraries. Its main utility is setting the
-correct --stagedir parameter value to avoid name clashes.
+The main utility of this script is setting the correct --stagedir parameter
+value to avoid name clashes.
+
+It also facilitates building with different toolsets/for different platforms
+with the help from the --toolset and --platform parameters.
Usage example:
diff --git a/project/boost/download.py b/project/boost/download.py
index b5bf684..a3bcf61 100644
--- a/project/boost/download.py
+++ b/project/boost/download.py
@@ -6,7 +6,8 @@
R'''Download & bootstrap Boost.
This script downloads and unpacks a Boost distribution archive. Its main
-utility is that it's supposed to be cross-platform.
+utility is that it's cross-platform & supports different Boost versions out of
+the box.
Usage examples:
diff --git a/project/build.py b/project/build.py
index ff366c3..f718bea 100644
--- a/project/build.py
+++ b/project/build.py
@@ -5,12 +5,13 @@
R'''Build a CMake project.
-This script is used basically to invoke the CMake executable in a
-cross-platform way (provided the platform has Python 3, of course). The
-motivation was to merge my Travis and AppVeyor build scripts (largely similar,
-but written in bash and PowerShell, respectively).
+This script works nicely with boost-build from this package - it will use the
+correct --stagedir directory automatically.
-A simple usage example:
+Also, it facilitates building with different toolsets/for different platforms
+with the help from the --toolset and --platform parameters.
+
+Usage example:
$ project-build --configuration Release --install path/to/somewhere -- examples/simple build/
...