Skip to content

Commit 09a6dab

Browse files
committed
Update README for v1.3
1 parent b6d3c54 commit 09a6dab

File tree

1 file changed

+4
-5
lines changed

1 file changed

+4
-5
lines changed

README.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,16 @@
44

55
## TooManyCooks
66
TooManyCooks is a runtime and concurrency library for C++20 coroutines. Its goals:
7-
- be the fastest general-purpose coroutine library available (see the :chart_with_upwards_trend: [benchmarks](https://github.com/tzcnt/runtime-benchmarks))
7+
- be the fastest general-purpose coroutine library available (see the [benchmarks](https://github.com/tzcnt/runtime-benchmarks))
88
- clean API with minimal noise
99
- extensive feature set
1010
- simple and clear path to migrate legacy applications
1111
- simple and clear path to integrate with 3rd-party executors/event loops
1212

1313
It provides:
1414
- a blazing fast, lock-free, work-stealing, continuation-stealing thread pool (`ex_cpu`)
15-
- automatic, hardware-optimized thread configuration via [hwloc](https://www.open-mpi.org/projects/hwloc/)
16-
- network I/O, file I/O, and timers support by integration with Asio (via :octocat: [tmc-asio](https://github.com/tzcnt/tmc-asio))
15+
- advanced hardware detection and thread configuration via [hwloc](https://www.open-mpi.org/projects/hwloc/)
16+
- network I/O, file I/O, and timers support by integration with Asio (via [tmc-asio](https://github.com/tzcnt/tmc-asio))
1717
- support for multiple task priority levels
1818
- support for both coroutines and regular functors in most APIs
1919
- a suite of utility functions for fluently interacting with tasks, awaitables, and executors
@@ -59,14 +59,13 @@ TooManyCooks is a header-only library. Adding it to your project is simple:
5959
1. Download the library and add `/include` to your include path.
6060
2. Add `#define TMC_IMPL` and `#include "tmc/all_headers.hpp"` to exactly one file in your project.
6161
62-
For a minimal project template, see :octocat: [tmc-hello-world](https://github.com/tzcnt/tmc-hello-world).
62+
For a minimal project template, see [tmc-hello-world](https://github.com/tzcnt/tmc-hello-world).
6363
6464
### Configuration
6565
TooManyCooks will work out of the box as a header-only library without any configuration.
6666
However, some performance tuning options are available. See the documentation section [Build-Time Options](https://fleetcode.com/oss/tmc/docs/latest/build_flags.html) for more info.
6767
6868
### Roadmap
69-
- v1.3: hwloc improvements (CPU topology query, P and E core detection, container CPU quota detection, unlimited threads)
7069
- v1.4: awaitable traits / concepts, zero-copy channel, awaitable result streaming
7170
- Beyond: See the [issues tagged "enhancement"](https://github.com/tzcnt/TooManyCooks/issues?q=is%3Aissue%20state%3Aopen%20label%3Aenhancement) for future planned work. Please leave a :thumbsup: on any issues that are important to you. I will use this as a way to gauge community interest on what should be developed next.
7271

0 commit comments

Comments
 (0)