Skip to content

Commit eaf6410

Browse files
committed
Corrected some editing errors in README
Signed-off-by: Ted Lyngmo <[email protected]>
1 parent bbb5fef commit eaf6410

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# beman.timed\_lock\_alg : Timed lock algorithms for multiple lockables
1+
# beman.timed_lock_alg : Timed lock algorithms for multiple lockables
22

33
<!--
44
SPDX-License-Identifier: MIT
@@ -266,41 +266,41 @@ Enable building examples. Default: ON. Values: { ON, OFF }.
266266
Enable installing the CMake config file package. Default: ON.
267267
Values: { ON, OFF }.
268268

269-
This is required so that users of `beman.timed\_lock\_alg` can use
269+
This is required so that users of `beman.timed_lock_alg` can use
270270
`find_package(beman.timed_lock_alg)` to locate the library.
271271

272272
</details>
273273

274-
## Integrate beman.timed\_lock\_alg into your project
274+
## Integrate beman.timed_lock_alg into your project
275275

276-
To use `beman.timed\_lock\_alg` in your C++ project,
277-
include an appropriate `beman.timed\_lock\_alg` header from your source code.
276+
To use `beman.timed_lock_alg` in your C++ project,
277+
include an appropriate `beman.timed_lock_alg` header from your source code.
278278

279279
```c++
280280
#include <beman/timed_lock_alg/mutex.hpp>
281281
```
282282

283283
> [!NOTE]
284284
>
285-
> `beman.timed\_lock\_alg` headers are to be included with the `beman/timed\_lock\_alg/` prefix.
285+
> `beman.timed_lock_alg` headers are to be included with the `beman/timed_lock_alg/` prefix.
286286
> Altering include search paths to spell the include target another way (e.g.
287287
> `#include <mutex.hpp>`) is unsupported.
288288
289-
The process for incorporating `beman.timed\_lock\_alg` into your project depends on the
289+
The process for incorporating `beman.timed_lock_alg` into your project depends on the
290290
build system being used. Instructions for CMake are provided in following sections.
291291

292-
### Incorporating `beman.timed\_lock\_alg` into your project with CMake
292+
### Incorporating `beman.timed_lock_alg` into your project with CMake
293293

294294
For CMake based projects,
295-
you will need to use the `beman.timed\_lock\_alg` CMake module
296-
to define the `beman::timed\_lock\_alg` CMake target:
295+
you will need to use the `beman.timed_lock_alg` CMake module
296+
to define the `beman::timed_lock_alg` CMake target:
297297

298298
```cmake
299299
find_package(beman.timed_lock_alg REQUIRED)
300300
```
301301

302-
You will also need to add `beman::timed\_lock\_alg` to the link libraries of
303-
any libraries or executables that include `beman.timed\_lock\_alg` headers.
302+
You will also need to add `beman::timed_lock_alg` to the link libraries of
303+
any libraries or executables that include `beman.timed_lock_alg` headers.
304304

305305
```cmake
306306
target_link_libraries(yourlib PUBLIC beman::timed_lock_alg)

0 commit comments

Comments
 (0)