Skip to content

Commit e94d6ae

Browse files
committed
update readme for new usage and dependencies
1 parent f25859e commit e94d6ae

File tree

1 file changed

+5
-7
lines changed

1 file changed

+5
-7
lines changed

README.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,29 +3,27 @@ An open-source C++ library developed and used at YScope.
33

44
# Usage
55

6-
## Via CMake's add_subdirectory()
7-
> Note: this is not accurate in this branch, which is a work in progress to use ystdlib-cpp as a
8-
CMake library
6+
## Via CMake's find_package
97

10-
Clone `ystdlib-cpp` into your project. Then, in your project's `CMakeLists.txt`, add the following:
8+
Install `ystdlib-cpp` into a directory. Then, in your project's `CMakeLists.txt`, add the following:
119
```cmake
1210
# Set `ystdlib_BUILD_TESTING` to an accepted `FALSE` class value to skip building unit tests.
1311
# option(ystdlib_BUILD_TESTING "" OFF)
14-
add_subdirectory(/path/to/ystdlib-cpp EXCLUDE_FROM_ALL)
12+
set(ystdlib_ROOT "PATH_TO_INSTALLATION")
13+
find_package(ystdlib REQUIRED)
1514
target_link_libraries(<target_name> <link_options>
1615
ystdlib::<lib_1> ystdlib::<lib_2> ... ystdlib::<lib_N>
1716
# other libs...
1817
)
1918
```
20-
Ensure that `ystdlib-cpp` is either within a subdirectory of the folder containing `CMakeLists.txt`
21-
or at the same level.
2219

2320
# Contributing
2421
Follow the steps below to develop and contribute to the project.
2522

2623
## Requirements
2724
* Python 3.10 or higher
2825
* [Task] 3.40.0 or higher
26+
* CMake 3.23 or higher
2927

3028
## Set up
3129
Initialize and update submodules:

0 commit comments

Comments
 (0)