forked from mirage/mirage-solo5
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
9 additions
and
9 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,14 +1,8 @@ | ||
# mirage-solo5 -- Solo5 core platform libraries for MirageOS | ||
|
||
This package provides the MirageOS `OS` library for | ||
[Solo5][1] targets, which handles the main loop and timers. It also provides | ||
the low level C startup code and C stubs required by the OCaml code. | ||
**Do not install this package manually.** If you came here from a search engine looking for information on MirageOS/Solo5, [start here](https://mirage.io/wiki/install). | ||
|
||
Currently this package also includes the C stubs used by the Solo5 `console`, | ||
`block` and `net` implementations. | ||
This package provides the [MirageOS](https://mirage.io/) `OS` library for [Solo5](https://github.com/Solo5/solo5) targets, which handles the main loop and timers. It also provides the low level C startup code and C [stubs](lib/bindings/) required by MirageOS on Solo5 targets. | ||
|
||
The OCaml runtime and C runtime required to support it are provided separately | ||
by the [ocaml-freestanding][2] package. | ||
|
||
[1]: https://github.com/Solo5/solo5 | ||
[2]: https://github.com/mirage/ocaml-freestanding | ||
by the [ocaml-freestanding](https://github.com/mirage/ocaml-freestanding) package. |