Skip to content

Commit

Permalink
format docs
Browse files Browse the repository at this point in the history
  • Loading branch information
petiaccja committed Mar 11, 2024
1 parent f52f581 commit b020744
Showing 1 changed file with 35 additions and 25 deletions.
60 changes: 35 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,31 +8,41 @@

`asyncpp` is a C++20 coroutine library that enables you to write asynchronous and parallel code with a clean syntax.

## Features

**Coroutines**:
- [task](#feature_task)
- [shared_task](#feature_task)
- [generator](#feature_generator)
- [stream](#feature_stream)

**Synchronization primitives**:
- [event](#feature_event)
- [broadcast_event](#feature_event)
- [mutex](#feature_mutex)
- [shared_mutex](#feature_mutex)
- [semaphores](#feature_semaphore)

**Utilities**:
- [join](#feature_join)
- [sleep_for, sleep_until](#feature_sleep)

**Schedulers**:
- [Introduction](#feature_scheduler)
- [thread_pool](#feature_thread_pool)

**Extra**:
- [Allocator awareness](#feature_allocator)
## Introduction

### Compiler support

- MSVC (tested for 19.3+)
- Clang (tested for 17+)
- GCC (tested for 13+)

You can probably use anything that properly supports C++20, but the CI runs on rather recent versions of the three main compilers.

### Features

- **Coroutines**:
- [task](#feature_task)
- [shared_task](#feature_task)
- [generator](#feature_generator)
- [stream](#feature_stream)
- **Synchronization**:
- [event](#feature_event)
- [broadcast_event](#feature_event)
- [mutex](#feature_mutex)
- [shared_mutex](#feature_mutex)
- [semaphores](#feature_semaphore)
- **Utilities**:
- [join](#feature_join)
- [sleep_for, sleep_until](#feature_sleep)
- **Schedulers**:
- [Scheduling in asyncpp](#feature_scheduler)
- [thread_pool](#feature_thread_pool)
- **Other**:
- [Allocator awareness](#feature_allocator)


### Extending `asyncpp`

- [Integration with other coroutine libraries](#feature_integration)
- [Extending asyncpp](#feature_extension)

Expand Down

0 comments on commit b020744

Please sign in to comment.