Skip to content

Commit fa812da

Browse files
authored
Update README.md
1 parent 5d52eef commit fa812da

File tree

1 file changed

+3
-14
lines changed

1 file changed

+3
-14
lines changed

README.md

Lines changed: 3 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -12,24 +12,19 @@ Header-only C++ helper library that provides small, cross-platform utilities and
1212
1313
## Documentation
1414

15-
* 📄 **[Overview](docs/overview.md)** – architecture, build & quick start.
16-
15+
* [Overview](docs/overview.md): Architecture, Build & Quick Start.
1716
* C++23, zero runtime dependencies
1817
* Delivered as an INTERFACE target `cpp_core::cpp_core`
1918
* Fetchable via [CPM.cmake](https://github.com/cpm-cmake/CPM.cmake) or regular `find_package`
2019

21-
---
22-
2320
## Requirements
2421

2522
* CMake ≥ 3.14
2623
* A C++23 compatible compiler (GCC 13+, Clang 16+, MSVC 2022+)
2724

28-
---
29-
3025
## Quick Start
3126

32-
### 1. Add *cpp-core* with CPM.cmake (recommended way)
27+
1. Add *cpp-core* with CPM.cmake (recommended way)
3328

3429
```cmake
3530
# Set the project version once via **cache variables** –
@@ -52,7 +47,7 @@ target_link_libraries(my_app PRIVATE cpp_core::cpp_core)
5247
> They guarantee the values exist **before** the `CPMAddPackage()` call. If the variables are set later (or via
5348
> `OPTIONS ... "CPP_CORE_VERSION_MAJOR=${FOO}"`) and `FOO` is empty at that moment, *cpp-core* falls back to its default version (0.1.0).
5449
55-
### 2. Use in code
50+
2. Use in code
5651

5752
```cpp
5853
#include <cpp_core/version.h>
@@ -63,8 +58,6 @@ int main() {
6358
}
6459
```
6560

66-
---
67-
6861
## Alternative: add_subdirectory
6962

7063
If you include the source code directly as a sub-repository, simply do:
@@ -74,8 +67,6 @@ add_subdirectory(externals/cpp-core)
7467
# the same version variables can be set before the call
7568
```
7669

77-
---
78-
7970
## Using the package with `find_package`
8071

8172
After running `cmake --install` (or `make install`) you can locate the package system-wide:
@@ -86,7 +77,5 @@ add_executable(my_app src/main.cpp)
8677
target_link_libraries(my_app PRIVATE cpp_core::cpp_core)
8778
```
8879

89-
---
90-
9180
## License
9281
Apache-2.0 – see [LICENSE](LICENSE).

0 commit comments

Comments
 (0)