Skip to content

Commit

Permalink
readme: Minor formatting fixes
Browse files Browse the repository at this point in the history
This commit fixes the warning box for pre-1.0 stability and the cmake
option table.
Additionally, a small clarification for the installation path for the
cmake example command and the PRIVATE keyword was added to the example
for cmake integration.
  • Loading branch information
taminob committed Mar 28, 2024
1 parent e775cca commit fc5e63b
Showing 1 changed file with 8 additions and 7 deletions.
15 changes: 8 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# PPPlugin

[!WARNING]
Until version 1.0.0 is released, all interfaces and features are subject
to change and there are no guarantees regarding stability.
> [!WARNING]
> Until version 1.0.0 is released, all interfaces and features are subject
> to change and there are no guarantees regarding stability.
This library aims to provide an easy-to-use and modern C++ interface
to extend an existing library at runtime via plugins.
Expand All @@ -17,7 +17,7 @@ interchangeably.
# set(PPPLUGIN_SHARED ON) # uncomment to use shared instead of static library
find_package(ppplugin REQUIRED)
target_link_library(<target> ppplugin::ppplugin)
target_link_library(<target> PRIVATE ppplugin::ppplugin)
```

For code usage, please refer to the different examples in `examples/`.
Expand All @@ -32,7 +32,8 @@ cmake --build build -j
cmake --install build --prefix build/root/usr/local
```

This will compile and install the library to the directory `build/root`.
This will compile and install the library to the directories
`build/root/usr/local/{include,lib}`.

Available compilation options:

Expand All @@ -42,8 +43,8 @@ Available compilation options:
| `PPPLUGIN_ENABLE_COVERAGE` | `OFF` | Enable flags for measuring test coverage |
| `PPPLUGIN_ENABLE_TESTS` | `OFF` | Tests in `tests` will be compiled |
| `PPPLUGIN_ENABLE_EXAMPLES` | `OFF` | Examples in `examples` will be compiled |
| `DPPPLUGIN_ENABLE_CPP17_COMPATIBILITY` | `OFF` | |
||| Library will be compiled with C++17 compatibility |
| `PPPLUGIN_ENABLE_CPP17_COMPATIBILITY` | `OFF` | Library will be compiled \\ |
||| with C++17 compatibility |

Extend the first command above with the desired options, for example:

Expand Down

0 comments on commit fc5e63b

Please sign in to comment.