From 130d7d07d0ee649a38b9b8df7d22404d960b2f09 Mon Sep 17 00:00:00 2001 From: wenyongh Date: Tue, 21 Jan 2020 14:24:10 +0800 Subject: [PATCH] Update document, fix typo of wamrc help info (#158) --- README.md | 14 +++++++------- doc/build_wasm_app.md | 4 +++- 2 files changed, 10 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 284c05c3..7db0c50e 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ WebAssembly Micro Runtime (WAMR) is a standalone WebAssembly (WASM) runtime with - The dynamic management of the WASM applications - + iwasm VM core ========================= @@ -22,7 +22,7 @@ iwasm VM core - Embeddable with the supporting C API's - Small runtime binary size (85K for interpreter and 50K for AoT) and low memory usage -- Near to native speed by AoT +- Near to native speed by AoT - AoT module loader works for both embedded OS and Linux system - Choices of WASM application libc support: the built-in libc subset for embedded environment or [WASI](https://github.com/WebAssembly/WASI) for standard libc - The mechanism for exporting native API's to WASM applications @@ -32,8 +32,8 @@ iwasm VM core The iwasm supports following architectures: - X86-64, X86-32 -- ARM, THUMB -- MIPS +- ARM, THUMB +- MIPS - XTENSA Following platforms are supported: @@ -75,7 +75,7 @@ WAMR provides a set of C API for loading the WASM module, instantiating the modu Application framework =================================== -By using the iwasm VM core, we are flexible to build different application frameworks for the specific domains, although it would take quite some efforts. +By using the iwasm VM core, we are flexible to build different application frameworks for the specific domains, although it would take quite some efforts. The WAMR has offered a comprehensive framework for programming WASM applications for device and IoT usages. The framework supports running multiple applications, which are based on the event driven programming model. Here are the supporting API sets by the [WAMR application library](./doc/wamr_api.md) : @@ -97,7 +97,7 @@ The WAMR application manager supports remote application management from host en -The tool [host_agent](./test-tools/host-tool) communicates to the WAMR app manager for installing/uninstalling the WASM applications on companion chip from host system. And the [IoT App Store Demo](./test-tools/IoT-APP-Store-Demo/) shows the conception of remotely managing the device applications from cloud. +The tool [host_tool](./test-tools/host-tool) communicates to the WAMR app manager for installing/uninstalling the WASM applications on companion chip from host system. And the [IoT App Store Demo](./test-tools/IoT-APP-Store-Demo/) shows the conception of remotely managing the device applications from cloud. @@ -110,7 +110,7 @@ The **wamr-sdk** tools build the WAMR to both **runtime SDK** for embedding by y ### Menu configuration for building SDK -Menu configuration is supported for easy integration of runtime components and application libraries for the target architecture and platform. +Menu configuration is supported for easy integration of runtime components and application libraries for the target architecture and platform. ``` cd wamr-sdk diff --git a/doc/build_wasm_app.md b/doc/build_wasm_app.md index 30ac9000..76ab8ca8 100644 --- a/doc/build_wasm_app.md +++ b/doc/build_wasm_app.md @@ -94,8 +94,10 @@ Usage: wamrc [options] -o output_file wasm_file Default is host arch, e.g. x86_64 = for ex. on arm or thumb: v5, v6m, v7a, v7m, etc. Use --target=help to list supported targets + --target-abi= Set the target ABI, e.g. gnu, eabi, gnueabihf, etc. (default: gnu) + Use --target-abi=help to list all the ABI supported --cpu= Set the target CPU (default: host CPU, e.g. skylake) - Use --target=help to list all the CPU supported + Use --cpu=help to list all the CPU supported --cpu-features= Enable or disable the CPU features Use +feature to enable a feature, or -feature to disable it For example, --cpu-features=+feature1,-feature2