diff --git a/README.md b/README.md index 402d389..a8d285f 100644 --- a/README.md +++ b/README.md @@ -1,25 +1,35 @@ -# wasm-sdk +# wasi-sdk-nixos + +WASM LLVM toolchain and WASI sysroot. + +Similar to [WebAssembly/wasi-sdk](https://github.com/WebAssembly/wasi-sdk), but re-implemented for NixOS. -A *Nix*-based SDK for C and C++ development targeting WebAssembly. ## Goals -* Lean toolchain leveraging as much as possible from upstream sources. +* Lean C/C++ toolchain leveraging as much as possible from upstream sources. * Basic levels of WASI (no threading, no exceptions). -## Versions +## Versioning + +Provided are the upstream versions that WebAssembly/wasi-sdk used mid 2024: * LLVM: 17 * wasi-libc: 21 +Future releases may upgrade these upstream versions. + ## Usage -The package contains all required dependencies in the following build subdirectories: +The default package contains all required dependencies in the following package subdirectories: * `bin`: compilers (`clang`, `clang++`) and linker (`wasm-ld`) * `include`: *libc* headers * `include/c++/v1`: *libcxx* headers * `lib`: all *libc* and *libcxx* static libraries * `lib/wasi`: compiler-rt builtins static library +* `share/wasi-sysroot`: the WASI sysroot + +For concrete usage examples, see [michaelfranzl/clang-wasm-browser-starterpack](https://github.com/michaelfranzl/clang-wasm-browser-starterpack).