Skip to content

Commit 5e0b72f

Browse files
committed
Update README.md
1 parent e8e264a commit 5e0b72f

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,30 @@ clang-format -i src/*.cpp include/*.hpp tests/*.cpp tests/*.hpp
6262
- CI runs on Clang + GCC using GitHub Actions.
6363
- You can safely override default settings in `CMakePresets.json`.
6464

65+
### Installation
66+
67+
This project supports CMake installation:
68+
```bash
69+
cmake --preset gcc-RelWithDebInfo
70+
cmake --build --preset gcc-RelWithDebInfo
71+
cmake --install build/gcc-RelWithDebInfo --prefix install
72+
```
73+
74+
This will install the compiled library, public headers and CMake config files for `find_package(...)` consumers.
75+
76+
#### Using in Another Project
77+
78+
After installation, your project can consume this library like so:
79+
```cmake
80+
find_package(modern_cpp_project REQUIRED)
81+
target_link_libraries(<your_app> PRIVATE modern_cpp_project::math)
82+
```
83+
84+
Add this to your CMake call:
85+
```bash
86+
cmake -DCMAKE_PREFIX_PATH=/path/to/install ..
87+
```
88+
6589
## License
6690

6791
This project is licensed under the [Apache License 2.0](LICENSE).

0 commit comments

Comments
 (0)