Update README with notes about OS (in)compatibility

This commit is contained in:
Mattia Giambirtone 2023-12-09 11:36:39 +01:00
parent d77ddcf6a6
commit 2601ebb514
Signed by: nocturn9x
GPG Key ID: 8270F9F467971E59
1 changed files with 8 additions and 1 deletions

View File

@ -13,4 +13,11 @@ technically it doesn't implement SC).
## Why?
This library (and [its](https://git.nocturn9x.space/nocturn9x/giambio) [predecessors](https://git.nocturn9x.space/nocturn9x/aiosched)) is just a way for me to test my knowledge and make sure I understand the basics of structured concurrency
and building solid coroutine runners so that I can implement the paradigm in my own programming language. For more info, see [here](https://git.nocturn9x.space/nocturn9x/peon).
and building solid coroutine runners so that I can implement the paradigm in my own programming language. For more info, see [here](https://git.nocturn9x.space/nocturn9x/peon).
**P.S.**: structio is only thoroughly tested for Linux: While Windows/macOS support is one of the goals
of the project, I currently don't have enough time to dedicate to the quirks of the I/O subsystem of each OS.
All features that don't rely on I/O (timeouts, events, queues, memory channels, etc.) are cross-platform, but
things like sockets behave very differently depending on the platform, and it'll take some time for me to
apply the necessary fixes for each of them. File I/O (in its current form using threads), as well as asynchronous
threads and processes _should_ work, but there's no guarantee