@@ -21,31 +21,23 @@ Each dependency is downloaded and the `STORAGE.cmake` in the remote git reposito
2121
2222## Usage
2323
24- Requirements:
24+ CMUTIL is intended to be used thru [ CMLIB ] .
2525
26- - [ CMLIB ] installed and works
26+ CMUTIL is not supposed to be used separately.
2727
28- then just call
29-
30- ```
31- FIND_PACKAGE(CMLIB COMPONENTS STORAGE)
32- ```
33-
34- it will initialize ` CMLIB_STORAGE ` and all shared storages registred in ` CMLibStorage.cmake ` .
35-
36- Look at example at [ example/] directory.
28+ To use the component install [ CMLIB] and call ` FIND_PACKAGE(CMLIB COMPONENTS CMUTIL) ` .
3729
3830## General
3931
40- [ CMake-lib] storage tracks and maintain remote git repositories in a simple way.
32+ [ CMake-lib] storage tracks and maintains remote git repositories in a simple way.
4133
42- It's intended for two main use-cases
34+ The component is intended for two main use-cases:
4335
44- - we want to store all URI in one place. We create repository and in the STORAGE.cmake
45- we store all remote URIs which the project needs
46- - we have some CMake macros/modules, build scripts/resources etc which are all common for all
47- components of our project. We just create git repository and upload all shared dependencies
48- into it.
36+ - to store all URIs in one place. The repository is created and in the STORAGE.cmake
37+ all remote URIs which the project needs are stored
38+ - when CMake macros/modules, build scripts/resources etc are common for all
39+ components of a project. A git repository is created and all shared dependencies
40+ are uploaded into it.
4941
5042### Remote GIT repository structure
5143
@@ -75,14 +67,14 @@ Look at example at [example/CMLibStorage.cmake]
7567
7668### Variable templates
7769
78- The Storage implements mechanism called "Variable template".
70+ The Storage implements a mechanism called "Variable template".
7971
80- Let's imagine that we have a URI for Boost. We want to write an app for Windows, Mac and Linux. \
81- let "https://mystorage.com/boost_107400_windows_amd64.zip " be a URI for Boost 1.74.0 for 64-bit windows.
72+ Consider a scenario with a URI for Boost. An application needs to be written for Windows, Mac and Linux. \
73+ Let "https://mystorage.com/boost_107400_windows_amd64.zip " be a URI for Boost 1.74.0 for 64-bit windows.
8274
83- We define variable in form ` SET(BOOST_URI_TEMPLATE "https://mystorage.com/boost_<version>_<OS>_<PlAtFoRm>.zip") `
75+ The variable is defined in the form ` SET(BOOST_URI_TEMPLATE "https://mystorage.com/boost_<version>_<OS>_<PlAtFoRm>.zip") `
8476
85- Once we want to obtain URL for Boost 1.74.0 for 64-bit windows by template variable BOOST_URI_TEMPLATE we just call
77+ To obtain the URL for Boost 1.74.0 for 64-bit windows using the template variable BOOST_URI_TEMPLATE, the following call is made:
8678
8779``` cmake
8880SET(BOOST_URI_TEMPLATE "https://mystorage.com/boost_<version>_<OS>_<PlAtFoRm>.zip")
@@ -100,9 +92,9 @@ It prints "https://mystorage.com/boost_107400_windows_amd64.zip".
10092
10193## Bug reports and feature requests
10294
103- If you want to submit a Bug report/feature request create a [ Github Issue] .
95+ Bug reports and feature requests can be submitted by creating a [ Github Issue] .
10496
105- If you have a question please use [ Github Discussion]
97+ Questions should be posted using [ Github Discussion]
10698
10799[ CMLIB ] : https://github.com/cmakelib
108100[ CMake-lib ] : https://github.com/cmakelib
0 commit comments