From 48cdbee4e084dcb399a270bd9e41ce041480236c Mon Sep 17 00:00:00 2001 From: Wenyong Huang Date: Thu, 2 Jun 2022 14:33:03 +0800 Subject: [PATCH] Update documents (#1203) Mention the Python binding and Go binding in README.md and embed_wamr.md. Fix typo of esp-idf link in build_wamr.md. --- README.md | 2 ++ doc/build_wamr.md | 6 +++--- doc/embed_wamr.md | 4 +++- 3 files changed, 8 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 4645bc4f..dac63583 100644 --- a/README.md +++ b/README.md @@ -19,6 +19,8 @@ Getting started ================== - [Build iwasm VM core](./doc/build_wamr.md) on [Linux](./doc/build_wamr.md#linux), [SGX](./doc/linux_sgx.md), [MacOS](./doc/build_wamr.md#macos) and [Windows](./doc/build_wamr.md#windows), and [Build wamrc AOT compiler](./README.md#build-wamrc-aot-compiler) - [Embed WAMR into host applications](./doc/embed_wamr.md) + - [Embed into C/C++](./doc/embed_wamr.md), [Embed into Python](./language-bindings/python), [Embed into Go](./language-bindings/go) + - [Register native APIs for WASM applications](./doc/export_native_api.md) - [Build WASM applications](./doc/build_wasm_app.md) - [Port WAMR to a new platform](./doc/port_wamr.md) diff --git a/doc/build_wamr.md b/doc/build_wamr.md index d3fe5a68..2bb3e7f1 100644 --- a/doc/build_wamr.md +++ b/doc/build_wamr.md @@ -216,7 +216,7 @@ To run an AOT file, firstly please refer to [Build wamrc AOT compiler](../README wamrc -o iwasm ``` - + To enable the `JIT` mode, firstly we should build LLVM: ``` Bash @@ -246,7 +246,7 @@ cd build cmake .. -DWAMR_BUILD_FAST_INTERP=0 make ``` - + Linux SGX (Intel Software Guard Extension) ------------------------- @@ -553,7 +553,7 @@ If you don't have it installed, follow the instructions [here](https://docs.espr ESP-IDF also installs the toolchains needed for compiling WAMR and ESP-IDF. A small demonstration of how to use WAMR and ESP-IDF can be found under [product_mini](/product-mini/platforms/esp-idf). The demo builds WAMR for ESP-IDF and runs a small wasm program. -In order to run it for your specific Espressif chip, edit the ['build.sh'](/product-mini/platforms/esp-idf/build.sh) file and put the correct toolchain file (see #Cross-compilation) and `IDF_TARGET`. +In order to run it for your specific Espressif chip, edit the ['build_and_run.sh'](/product-mini/platforms/esp-idf/build_and_run.sh) file and put the correct toolchain file (see #Cross-compilation) and `IDF_TARGET`. Before compiling it is also necessary to call ESP-IDF's `export.sh` script to bring all compile time relevant information in scope. Docker diff --git a/doc/embed_wamr.md b/doc/embed_wamr.md index b78a0be6..4719bdea 100644 --- a/doc/embed_wamr.md +++ b/doc/embed_wamr.md @@ -1,7 +1,9 @@ Embedding WAMR guideline ===================================== -**Note**: All the embedding APIs supported by the runtime are defined under folder [core/iwasm/include](../core/iwasm/include). The API details are available in the header files. +**Note**: This document is about how to embed WAMR into C/C++ host applications, for other languages, please refer to: [Embed WAMR into Python](../language-bindings/go), [Embed WAMR into Go](../language-bindings/go). + +All the embedding APIs supported by the runtime are defined under folder [core/iwasm/include](../core/iwasm/include). The API details are available in the header files. ## Embed WAMR into developer's project