From e2403c3ee91f7d97e4fed6ad574e7f123e5e29c0 Mon Sep 17 00:00:00 2001 From: Wenyong Huang Date: Tue, 25 Jan 2022 20:24:33 +0800 Subject: [PATCH] Update documents (#984) Fix wamr-ide link error, set wamr-ide to experimental and fix README issues --- README.md | 4 ++-- doc/memory_tune.md | 2 +- test-tools/wamr-ide/README.md | 4 ++-- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 08349d94..bd7a29d3 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ WebAssembly Micro Runtime [BA]: https://bytecodealliance.org/ -WebAssembly Micro Runtime (WAMR) is a lightweight standalone WebAssembly (WASM) runtime with small footprint, high performance and highly configurable features for applications cross from embedded, IoT, edge to Trusted Execution Environment (TEE), smart contract, cloud native applications and so on. It includes a few parts as below: +WebAssembly Micro Runtime (WAMR) is a lightweight standalone WebAssembly (WASM) runtime with small footprint, high performance and highly configurable features for applications cross from embedded, IoT, edge to Trusted Execution Environment (TEE), smart contract, cloud native and so on. It includes a few parts as below: - The [**"iwasm" VM core**](./README.md#iwasm-vm-core) to run WASM applications, supporting interpreter mode, AOT mode (Ahead-of-Time compilation) and JIT mode (Just-in-Time compilation) - The [**"wamrc" AOT compiler**](./README.md#build-wamrc-aot-compiler) to compile WASM file into AOT file for best performance and smaller runtime footprint, which is run by "iwasm" VM Core @@ -61,7 +61,7 @@ The iwasm supports the following architectures: - RISCV64, RISCV32 (RISC-V LP64 and RISC-V LP64D are tested) - XTENSA, MIPS, ARC -Following platforms are supported, click each link below for how to build iwasm on that platform. Refer to [WAMR porting guide](./doc/port_wamr.md) for how to port WAMR to a new platform. +The following platforms are supported, click each link below for how to build iwasm on that platform. Refer to [WAMR porting guide](./doc/port_wamr.md) for how to port WAMR to a new platform. - [Linux](./doc/build_wamr.md#linux), [Linux SGX (Intel Software Guard Extension)](./doc/linux_sgx.md), [MacOS](./doc/build_wamr.md#macos), [Android](./doc/build_wamr.md#android), [Windows](./doc/build_wamr.md#windows) - [Zephyr](./doc/build_wamr.md#zephyr), [AliOS-Things](./doc/build_wamr.md#alios-things), [VxWorks](./doc/build_wamr.md#vxworks), [NuttX](./doc/build_wamr.md#nuttx), [RT-Thread](./doc/build_wamr.md#RT-Thread), [ESP-IDF](./doc/build_wamr.md#esp-idf) diff --git a/doc/memory_tune.md b/doc/memory_tune.md index d42f9957..ad1cc0a0 100644 --- a/doc/memory_tune.md +++ b/doc/memory_tune.md @@ -5,7 +5,7 @@ Memory model and memory usage tunning The memory model of WAMR can be basically described as below: -![WAMR memory model](./pics/wamr_memory_model.png "WAMR memory model") +
Note: - **global heap**: the heap to allocate memory for runtime data structures, including wasm module, wasm module instance, exec env, wasm operand stack and so on. It is initialized by `wasm_runtime_init` or `wasm_runtime_full_init`. And for `wasm_runtime_full_init`, developer can specify the memory allocation mode with `RuntimeInitArgs *init_args`: allocate memory from a user defined byte buffer, from user defined allocation function, or from the platform's os_malloc function. Refer to [wasm_export.h](../core/iwasm/include/wasm_export.h#L98-L141) and [Embedding WAMR guideline](doc/embed_wamr.md#the-runtime-initialization) for more details. And developer can use `wasm_runtime_malloc/wasm_runtime_free` to allocate/free memory from/to the global heap. diff --git a/test-tools/wamr-ide/README.md b/test-tools/wamr-ide/README.md index 7e11695b..720e0e18 100644 --- a/test-tools/wamr-ide/README.md +++ b/test-tools/wamr-ide/README.md @@ -1,4 +1,4 @@ -# WAMR-IDE +# WAMR-IDE (Experimental) ## Introduction @@ -62,7 +62,7 @@ The WAMR-IDE is an Integrated Development Environment to develop WebAssembly app #### `WAMR-IDE` extension contains 2 components as following picture showing. `Project management` and `Execution management` -![wamr_ide_main_menu](../Media/wamr_ide_main_menu.png "wamr-ide main menu") +![wamr_ide_main_menu](./Media/wamr_ide_main_menu.png "wamr-ide main menu") ### Project Management