From 0086ccf0272fa195dca36845fde9c54149c72f0e Mon Sep 17 00:00:00 2001 From: Xavier Del Campo Romero Date: Thu, 6 Mar 2025 16:37:12 +0100 Subject: First commit --- README.md | 55 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 55 insertions(+) create mode 100644 README.md (limited to 'README.md') diff --git a/README.md b/README.md new file mode 100644 index 0000000..7e5243a --- /dev/null +++ b/README.md @@ -0,0 +1,55 @@ +# `nwc`, a NanoWasm compiler + +`nwc` is a command-line tool that takes a MVP WebAssembly file and appends +[NanoWasm custom sections](https://gitea.privatedns.org/xavi/nanowasm-design) +to it, so that NanoWasm-capable interpreters such as +[`nanowasm`](https://gitea.privatedns.org/xavi/nanowasm) can consume them. + +## Building from source + +`nwc` only requires a C99 environment to build. The build system is based on +CMake and can be configured using the conventional process in CMake projects: + +``` +cmake -B build +``` + +Then, build with: + +``` +cmake --build build/ +``` + +## Usage + +The command below shall generate a NanoWasm-compatible file given by `out` +from a MVP WebAssembly file given by `infile`: + +``` +nwc +``` + +Take into account that `infile` **must not** contain any NanoWasm custom +sections. + +## License + +``` +nwc, a NanoWasm compiler +Copyright (C) 2025 Xavier Del Campo Romero + +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU Affero General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU Affero General Public License for more details. + +You should have received a copy of the GNU Affero General Public License +along with this program. If not, see . +``` + +Also, see [`LICENSE`](LICENSE). -- cgit v1.2.3