@@ -6,8 +6,8 @@ An open-source C++ library developed and used at YScope.
66
77## Via CMake's ` find_package `
88
9- First, [ install] ( #installing ) ` ystdlib ` onto your system. Then, in your project's ` CMakeLists.txt ` ,
10- add the following:
9+ First, [ build ] ( #building ) and [ install] ( #installing ) ` ystdlib ` onto your system. Then, in your
10+ project's ` CMakeLists.txt ` , add the following:
1111
1212``` cmake
1313# If `BUILD_TESTING` is set, set `ystdlib_BUILD_TESTING` to an accepted `FALSE` class value to skip
@@ -31,7 +31,6 @@ Follow the steps below to develop and contribute to the project.
3131* CMake 3.23 or higher
3232* Python 3.10 or higher
3333* [ Task] 3.40.0 or higher
34- * [ uv] 0.7.10 or higher
3534
3635## Set up
3736Initialize and update submodules:
@@ -41,57 +40,43 @@ git submodule update --init --recursive
4140
4241If you want to open the project in an IDE, run the following command to install any necessary
4342dependencies from source:
44-
4543``` shell
46- task deps:all
44+ task deps:install- all
4745```
4846
4947## Building
50-
51- To build all libraries (targets) run:
52-
48+ To build all targets:
5349``` shell
54- task build:build- all-release
50+ task build:all
5551```
5652
57- To build a single library (target) use the format:
58-
53+ To build an executable containing all unit tests:
5954``` shell
60- task build:build-< target> -< build type>
61- e.g.:
62- task build:build-error_handling-release
55+ task build:unit-test-all
6356```
6457
65- ## Installing
66-
67- To build and install ystdlib run:
68-
58+ To build an executable containing a single library's unit tests:
6959``` shell
70- task build:install-all-release INSTALL_PREFIX= " /install/prefix/path "
60+ task build:unit-test- < lib_name >
7161```
7262
73- To build and install a single library (target) use the format:
63+ ## Installing
64+
65+ After [ building] ( building ) install with:
7466
7567``` shell
76- task build:install-< target> -< build type> INSTALL_PREFIX=" <prefix path>"
77- e.g.:
78- task build:install-error_handling-release
68+ cmake --install " ./build" --prefix " ~/.local"
7969```
8070
8171## Testing
82-
83- To build and run all unit tests use:
84-
72+ To build and run all unit tests:
8573``` shell
86- task test:test -all-debug
74+ task test-all
8775```
8876
89- To build and run the unit tests for a single library (target) use the format:
90-
77+ To build and run unit tests for a specific library:
9178``` shell
92- task test:test-< target> -< build type>
93- e.g.:
94- task test:test-error_handling-release
79+ task test-< lib_name>
9580```
9681
9782When generating a testing target, the CMake variable ` BUILD_TESTING ` is followed (unless overruled
@@ -119,4 +104,3 @@ task -a
119104Look for all tasks under the ` lint ` namespace (identified by the ` lint: ` prefix).
120105
121106[ Task ] : https://taskfile.dev
122- [ uv ] : https://docs.astral.sh/uv
0 commit comments