Skip to content

Commit 9f5c56b

Browse files
committed
doc: Divide the example table to two parts
One part for embARC applications. One part for embARC examples.
1 parent 1d211e5 commit 9f5c56b

File tree

1 file changed

+14
-7
lines changed

1 file changed

+14
-7
lines changed

doc/documents/example/example_description.doc

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -267,6 +267,10 @@ See \ref sect_example_usage_GeneralBuildSteps for more details.
267267

268268
\section sect_example_build_an_application_in_embARC Building an Application in embARC
269269

270+
We provided some examples and applications in embARC, user can take reference from them.
271+
- Access to the examples: [source code of embARC examples](https://github.com/foss-for-synopsys-dwc-arc-processors/embarc_osp/tree/master/example)
272+
- Access to the applications: [source code of embARC applications](https://github.com/foss-for-synopsys-dwc-arc-processors/embarc_applications)
273+
270274
Studying the provided example makefiles which cover all the components is a recommended way to build your application in embARC. Getting Started Guides are provided for both Windows and Linux on the embARC.org website.
271275
- <a href="https://embarc.org/help.html#guides"><b>Getting Started with embARC on Windows/Linux Host</b></a>
272276
- <a href="https://embarc.org/help.html#notes"><b>embARC Application Notes</b></a>
@@ -289,11 +293,11 @@ The embARC platform comes with a large range of examples using the various OS, m
289293
These examples provide a useful reference and starting point for embARC developers for their own applications. \n
290294
The .elf files of the following examples can be loaded through JTAG, or the .bin files through SD card by secondary bootloader .
291295

292-
Please visit \ref EMBARC_APPS and \ref EMBARC_APPS_USERGUIDE "Example Usage Guide" for detailed usage information.
296+
Please visit \ref EMBARC_APPS "embARC Examples", [<b>embARC Applications</b>](https://github.com/foss-for-synopsys-dwc-arc-processors/embarc_applications)
297+
and \ref EMBARC_APPS_USERGUIDE "Example Usage Guide" for detailed usage information.
293298

294299
\anchor EMBARC_EXAMPLE_DOCUMENTTABLE
295-
Here is the list of embARC examples.
296-
300+
- **Here is the list of embARC examples**
297301
| Example Name | Example Directory | Example Document Link |
298302
| --------------------------- | ---------------------------------- | -------------------------------------- |
299303
| baremetal_arc_feature_axs103 | baremetal/arc_feature/axs103 | \ref EMBARC_APP_BAREMETAL_ARC_FEATURE_AXS103 |
@@ -322,10 +326,6 @@ Here is the list of embARC examples.
322326
| contiki_tinydtls_dtls_server_ipv4 | contiki/tinydtls/dtls_server_ipv4 | \ref EMBARC_APP_CONTIKI_TINYDTLS_DTLS_SERVER_IPV4 |
323327
| contiki_xively_http | contiki/xively_http | \ref EMBARC_APP_CONTIKI_XIVELY_HTTP |
324328
| contiki_xively_mqtt | contiki/xively_mqtt | \ref EMBARC_APP_CONTIKI_XIVELY_MQTT |
325-
| freertos_iot_aws_smarthome_demo | freertos/iot/aws/smarthome_demo | \ref EMBARC_APP_FREERTOS_IOT_AWS_SMARTHOME_DEMO |
326-
| freertos_iot_aws_smarthome_nodes_frontDoor | freertos/iot/aws/smarthome_nodes/frontDoor | \ref EMBARC_APP_FREERTOS_IOT_AWS_SMARTHOME_NODES_FRONTDOOR |
327-
| freertos_iot_aws_smarthome_nodes_kitchen | freertos/iot/aws/smarthome_nodes/kitchen | \ref EMBARC_APP_FREERTOS_IOT_AWS_SMARTHOME_NODES_KITCHEN |
328-
| freertos_iot_aws_smarthome_nodes_livingRoom | freertos/iot/aws/smarthome_nodes/livingRoom | \ref EMBARC_APP_FREERTOS_IOT_AWS_SMARTHOME_NODES_LIVINGROOM |
329329
| freertos_iot_coap_coap_server | freertos/iot/coap/coap_server | \ref EMBARC_APP_FREERTOS_IOT_COAP_COAP_SERVER |
330330
| freertos_iot_lwm2m_iot_demo | freertos/iot/lwm2m/iot_demo | \ref EMBARC_APP_FREERTOS_IOT_LWM2M_IOT_DEMO |
331331
| freertos_iot_lwm2m_lwm2m_client | freertos/iot/lwm2m/lwm2m_client | \ref EMBARC_APP_FREERTOS_IOT_LWM2M_LWM2M_CLIENT |
@@ -344,6 +344,13 @@ Here is the list of embARC examples.
344344
| freertos_sec_wolfssl_client | freertos/sec/wolfssl/client | \ref EMBARC_APP_FREERTOS_SEC_WOLFSSL_CLIENT |
345345
| freertos_sec_wolfssl_server | freertos/sec/wolfssl/server | \ref EMBARC_APP_FREERTOS_SEC_WOLFSSL_SERVER |
346346

347+
- **Here is a list of embARC applications**
348+
| Application Name | Application Directory | Application Document Link |
349+
| --------------------------- | ---------------------------------- | -------------------------------------- |
350+
| aws_iot_smarthome_demo | aws_iot_smarthome/src | \ref EMBARC_APP_FREERTOS_IOT_AWS_SMARTHOME_DEMO |
351+
| aws_iot_smarthome_nodes_frontDoor | aws_iot_smarthome_multinode/src/frontDoor | \ref EMBARC_APP_FREERTOS_IOT_AWS_SMARTHOME_NODES_FRONTDOOR |
352+
| aws_iot_smarthome_nodes_kitchen | aws_iot_smarthome_multinode/src/kitchen | \ref EMBARC_APP_FREERTOS_IOT_AWS_SMARTHOME_NODES_KITCHEN |
353+
| aws_iot_smarthome_nodes_livingRoom | aws_iot_smarthome_multinode/src/livingRoom | \ref EMBARC_APP_FREERTOS_IOT_AWS_SMARTHOME_NODES_LIVINGROOM |
347354

348355
\section sect_example_division_of_provided_embARC_examples Division of embARC Examples
349356

0 commit comments

Comments
 (0)