add readme for runtime abi

This commit is contained in:
Mackenzie Clark 2019-03-12 10:57:47 -07:00
parent cc3f04efd7
commit 76531b4fcb

16
lib/runtime-abi/README.md Normal file
View File

@ -0,0 +1,16 @@
# runtime-abi
This crate has ABI functions (like syscalls) and extensions to the runtime for enabling ABIs (e.g. virtual filesystem).
## Virtual Filesystem (experimental)
The virtual filesystem allows the runtime to read bundled wasm data as if they were files. Data that is stored in a
custom section compressed with [zstd][1] compression and archived with [tar][2] will be exposed as files and mounted
in the `/` root.
The only current supported operation is the `read` syscall.
The virtual filesystem is not enabled by default. Build with `--features vfs` to use it.
[1]: https://facebook.github.io/zstd/
[2]: https://www.gnu.org/software/tar/