Skip to content

Commit

Permalink
Link to current status GitHub issue
Browse files Browse the repository at this point in the history
It's easier to track progress in an issue rather than in the README.
  • Loading branch information
talex5 committed Dec 14, 2022
1 parent e277fce commit 51e2029
Showing 1 changed file with 3 additions and 18 deletions.
21 changes: 3 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,27 +80,12 @@ and we hope that Eio will be that API.

## Current Status

Platform support:

- Unix and macos: should be fully working using the libuv backend.
- Linux: can additionally use io_uring for better performance on recent kernels.
- Windows: should be mostly working - see [#125](https://github.com/ocaml-multicore/eio/issues/125) for remaining tasks.
- MirageOS: waiting for [ocaml-freestanding](https://github.com/mirage/ocaml-freestanding) to be updated to OCaml 5.0.
- Browsers: waiting for [js_of_ocaml](https://github.com/ocsigen/js_of_ocaml/issues/1088) to be updated to OCaml 5.0.

Feature status:

- Concurrency primitives: Fibers, cancellation, promises, streams and semaphores are all working.
- Multicore support: Working.
- Networking: Clients and servers using TCP, UDP and Unix domain sockets work.
- File-systems: Can create files and directories, load, save, parse, etc. Most other operations missing.
- Spawning sub-processes: Not implemented yet (see [#330](https://github.com/ocaml-multicore/eio/pull/330)).
See [Eio 1.0 progress tracking](https://github.com/ocaml-multicore/eio/issues/388) for the current status.
Please try porting your programs to use Eio and submit PRs or open issues when you find problems.
Remember that you can always fall back to using Lwt libraries to provide missing features if necessary.

See [Awesome Multicore OCaml][] for links to work migrating other projects to Eio.

If you'd like to help out, please try porting your program to use Eio and submit PRs or open issues when you find problems.
Remember that you can always fall back to using Lwt libraries to provide missing features if necessary.

## Structure of the Code

- [Eio][] provides concurrency primitives (promises, etc.) and a high-level, cross-platform OS API.
Expand Down

0 comments on commit 51e2029

Please sign in to comment.