[wasi-libc.git] / README.md

# WebAssembly Reference Sysroot

Caution: This is currently quite experimental and not generally usable yet!

## What is this?

This is a "reference sysroot", which is meant to be part of a common C ABI
that can be shared across C libraries and compilers. While it's intened to
(eventually) be usable in its own right, we fully expect other
implementations to be used in practice by many different systems, though
we do hope that in those cases, this library defines a useful ABI that can
be followed.

## Usage

Obtain a WebAssembly-supporting C compiler, and then run:

```
make WASM_CC=/path/to/wasm/supporting/c/compiler
```

This makes a directory called "sysroot", by default. See the top of the Makfile
for customization options.

To use the sysroot, use the `--sysroot=` option:

```
/path/to/wasm/supporting/c/compiler --sysroot=/path/to/the/newly/built/sysroot ...
``

to run the compiler using the newly built sysroot.
Commit	Line	Data
dcf13b6f DG	1	# WebAssembly Reference Sysroot
	2
	3	Caution: This is currently quite experimental and not generally usable yet!
	4
	5	## What is this?
	6
	7	This is a "reference sysroot", which is meant to be part of a common C ABI
	8	that can be shared across C libraries and compilers. While it's intened to
	9	(eventually) be usable in its own right, we fully expect other
	10	implementations to be used in practice by many different systems, though
	11	we do hope that in those cases, this library defines a useful ABI that can
	12	be followed.
	13
	14	## Usage
	15
	16	Obtain a WebAssembly-supporting C compiler, and then run:
	17
	18	```
	19	make WASM_CC=/path/to/wasm/supporting/c/compiler
	20	```
	21
	22	This makes a directory called "sysroot", by default. See the top of the Makfile
	23	for customization options.
	24
	25	To use the sysroot, use the `--sysroot=` option:
	26
	27	```
	28	/path/to/wasm/supporting/c/compiler --sysroot=/path/to/the/newly/built/sysroot ...
	29	``
	30
	31	to run the compiler using the newly built sysroot.