aboutsummaryrefslogtreecommitdiffstatshomepage
diff options
context:
space:
mode:
authorEgor Tensin <Egor.Tensin@gmail.com>2021-04-14 00:25:22 +0300
committerEgor Tensin <Egor.Tensin@gmail.com>2021-04-14 00:25:22 +0300
commit2f13d5a050f1190538e011ccdfb3be3603e1051d (patch)
tree762268ff005d8d7d4c728db49eae767eba64884c
parentfix PyLint warnings (diff)
downloadcmake-common-2f13d5a050f1190538e011ccdfb3be3603e1051d.tar.gz
cmake-common-2f13d5a050f1190538e011ccdfb3be3603e1051d.zip
update script names in README and --help output
-rw-r--r--README.md30
-rw-r--r--project/boost/build.py2
-rw-r--r--project/boost/download.py4
-rw-r--r--project/cmake/build.py2
4 files changed, 19 insertions, 19 deletions
diff --git a/README.md b/README.md
index b909353..d801891 100644
--- a/README.md
+++ b/README.md
@@ -7,6 +7,11 @@ cmake-common
Various utilities to help develop C++/CMake projects.
+Installation
+------------
+
+ pip install cmake-common
+
Toolchains
----------
@@ -55,22 +60,19 @@ Everything is optional (use the `CC_*` CMake options to opt out).
Download & build the Boost libraries in a cross-platform way.
- $ python3 -m project.boost.download 1.72.0
+ $ boost-download 1.72.0
...
- $ python3 -m project.boost.build -- boost_1_72_0/ --with-filesystem --with-program_options
+ $ boost-build -- boost_1_72_0/ --with-filesystem --with-program_options
...
Pass the `--help` flag to view detailed usage information.
- $ python3 -m project.boost.download --help
- $ python3 -m project.boost.build --help
-
### CMake project
Build (and optionally, install) a CMake project.
- $ python3 -m project.cmake.build --configuration Release --install path/to/somewhere -- examples/simple
+ $ cmake-build --configuration Release --install path/to/somewhere --boost path/to/boost -- examples/simple
...
$ ./path/to/somewhere/bin/foo
@@ -78,12 +80,10 @@ Build (and optionally, install) a CMake project.
Pass the `--help` flag to view detailed usage information.
- $ python3 -m project.cmake.build --help
-
### CI
-Utility modules `project.ci.boost` and `project.ci.cmake` allow building Boost
-and CMake projects on multiple CI systems.
+Utility scripts `ci-boost` and `ci-cmake` allow building Boost and CMake
+projects on multiple CI systems.
They work by calling the generic scripts from above, auto-filling some
parameters from environment variables.
@@ -111,19 +111,19 @@ env:
- configuration=Debug platform=x64
- configuration=Release platform=x64
-before_script: python3 -m project.ci.boost -- --with-filesystem
-script: python3 -m project.ci.cmake --install
+before_script: ci-boost -- --with-filesystem
+script: ci-cmake --install
```
is roughly equivalent to running
```
-python3 -m project.boost.download --cache "$TRAVIS_BUILD_DIR/../build" -- 1.65.0
+boost-download --cache "$TRAVIS_BUILD_DIR/../build" -- 1.65.0
mv -- \
"$TRAVIS_BUILD_DIR/../build/boost_1_65_0" \
"$TRAVIS_BUILD_DIR/../build/boost"
-python3 -m project.boost.build \
+boost-build \
--platform x64 \
--configuration Debug Release \
-- \
@@ -131,7 +131,7 @@ python3 -m project.boost.build \
--with-filesystem
for configuration in Debug Release; do
- python3 -m project.cmake.build \
+ cmake-build \
--platform x64 \
--configuration "$configuration" \
--boost "$TRAVIS_BUILD_DIR/../build/boost" \
diff --git a/project/boost/build.py b/project/boost/build.py
index 9b44b2f..a3259ce 100644
--- a/project/boost/build.py
+++ b/project/boost/build.py
@@ -10,7 +10,7 @@ correct --stagedir parameter value to avoid name clashes.
Usage example:
- $ python -m project.boost.build -- boost_1_71_0/ --with-filesystem --with-program_options
+ $ boost-build -- boost_1_71_0/ --with-filesystem --with-program_options
...
Consult the output of `python -m project.boost.build --help` for more details.
diff --git a/project/boost/download.py b/project/boost/download.py
index f2ad21d..df92e0a 100644
--- a/project/boost/download.py
+++ b/project/boost/download.py
@@ -10,10 +10,10 @@ utility is that it's supposed to be cross-platform.
Usage examples:
- $ python -m project.boost.download 1.71.0
+ $ boost-download 1.71.0
...
- $ python -m project.boost.download --unpack ~/workspace/third-party/ 1.65.0
+ $ boost-download --unpack ~/workspace/third-party/ 1.65.0
...
'''
diff --git a/project/cmake/build.py b/project/cmake/build.py
index 74cafa6..74eb820 100644
--- a/project/cmake/build.py
+++ b/project/cmake/build.py
@@ -12,7 +12,7 @@ but written in bash and PowerShell, respectively).
A simple usage example:
- $ python -m project.cmake.build --configuration Release --install path/to/somewhere -- examples/simple
+ $ cmake-build --configuration Release --install path/to/somewhere -- examples/simple
...
$ ./path/to/somewhere/bin/foo