Эх сурвалжийг харах

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.
Wenyong Huang 3 жил өмнө
parent
commit
48cdbee4e0
3 өөрчлөгдсөн 8 нэмэгдсэн , 4 устгасан
  1. 2 0
      README.md
  2. 3 3
      doc/build_wamr.md
  3. 3 1
      doc/embed_wamr.md

+ 2 - 0
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)

+ 3 - 3
doc/build_wamr.md

@@ -216,7 +216,7 @@ To run an AOT file, firstly please refer to [Build wamrc AOT compiler](../README
 wamrc -o <AOT file> <WASM file>
 iwasm <AOT file>
 ```
-  
+
 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

+ 3 - 1
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