Skip to content

Commit c2b73ea

Browse files
authored
Readme refactoring (#2038)
1 parent 83659fa commit c2b73ea

10 files changed

Lines changed: 572 additions & 609 deletions

File tree

README.md

Lines changed: 36 additions & 125 deletions
Large diffs are not rendered by default.

core/app-framework/README.md

Lines changed: 11 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,27 @@
1-
Application framework
2-
=======
3-
4-
## Directory structure
1+
# Application framework
52

3+
By using the WAMR VM core, we are flexible to build different application frameworks for the specific domains, although it would take quite some effort.
64

5+
The WAMR has offered a comprehensive framework for programming WASM applications for device and IoT usages. The framework supports running multiple applications, that are based on the event driven programming model. Here are the supporting API sets by the [WAMR application framework library](../doc/wamr_api.md) :
76

8-
This folder "app-native-shared" is for the source files shared by both WASM APP and native runtime
7+
- Timer, Inter-app communication (request/response and pub/sub), Sensor, Connectivity and data transmission, 2D graphic UI
98

10-
- The c files in this directory are compiled into both the WASM APP and runtime.
11-
- The header files for distributing to SDK are placed in the "bi-inc" folder.
9+
Browse the folder [core/app-framework](./app-framework) for how to extend the application framework.
1210

1311

12+
## Directory structure
13+
This folder "app-native-shared" is for the source files shared by both WASM APP and native runtime
1414

15-
This folder "template" contains a pre-defined directory structure for a framework component. The developers can copy the template folder to create new components to the application framework.
16-
15+
- The c files in this directory are compiled into both the WASM APP and runtime.
16+
- The header files for distributing to SDK are placed in the "bi-inc" folder.
1717

18+
This folder "template" contains a pre-defined directory structure for a framework component. The developers can copy the template folder to create new components to the application framework.
1819

19-
Every other subfolder is framework component. Each component contains two library parts: **app and native**.
20+
Every other subfolder is framework component. Each component contains two library parts: **app and native**.
2021

2122
- The "base" component provide timer API and inter-app communication support. It must be enabled if other components are selected.
2223
- Under the "app" folder of a component, the subfolder "wa_inc" holds all header files that should be included by the WASM applications
2324

24-
25-
2625
## Application framework basic model
2726

2827
The app framework is built on top of two fundamental operations:
@@ -116,10 +115,6 @@ Generally you should follow following steps to create a new component:
116115
```
117116
118117
119-
120118
## Sensor component working flow
121-
122-
123-
124119
![](../../doc/pics/sensor_callflow.PNG)
125120

core/app-mgr/README.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,8 @@
1-
WASM application management
2-
=======
3-
4-
## structure
5-
1+
# Remote application management
62

3+
The WAMR application manager supports [remote application management](../core/app-mgr) from the host environment or the cloud through any physical communications such as TCP, UPD, UART, BLE, etc. Its modular design makes it able to support application management for different managed runtimes.
74

5+
The tool [host_tool](../test-tools/host-tool) communicates to the WAMR app manager for installing/uninstalling the WASM applications on companion chip from the host system. And the [IoT App Store Demo](../test-tools/IoT-APP-Store-Demo/) shows the conception of remotely managing the device applications from the cloud.
86

97

108
<img src="../../doc/pics/wamr-arch.JPG" width="80%">

0 commit comments

Comments
 (0)