aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/README.md
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 /README.md
parentcommon.cmake: refactoring (diff)
downloadcmake-common-0e35c671fecaad258bb8720867653389da642039.tar.gz
cmake-common-0e35c671fecaad258bb8720867653389da642039.zip
README & --help message updates
Diffstat (limited to 'README.md')
-rw-r--r--README.md13
1 files changed, 11 insertions, 2 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
-----